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

A

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

B

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

C

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

D

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

E

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

F

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

G

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

I - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
Deprecated.
will be removed in 2.0.0
ICU4JImpl() - Constructor for class org.apache.pdfbox.util.ICU4JImpl
Deprecated.
Constructor.
ID - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ID_TREE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
 
IM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.
ImageIOUtil - Class in org.apache.pdfbox.util
Handles some ImageIO operations.
imageMask(BufferedImage) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
 
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.
imageSizeInPercents(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
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.
importPageAsForm(PDDocument, int) - Method in class org.apache.pdfbox.util.LayerUtility
Imports a page from some PDF file as a Form XObject so it can be placed on another page in the target document.
importPageAsForm(PDDocument, PDPage) - Method in class org.apache.pdfbox.util.LayerUtility
Imports a page from some PDF file as a Form XObject so it can be placed on another page in the target document.
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(byte[]) - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Import an XMP stream into the PDF document.
importXMPMetadata(XMPMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Deprecated.
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
A common COSName value.
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.
initialParse() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
The initial parse will first parse only the trailer, the xrefstart and all xref tables to have a pointer (offset) to all the pdf's objects.
injectAppearanceStreams(PDStream, PDStream, PDStream, String, String, String, PDVisibleSignDesigner) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
injects appearance streams
injectAppearanceStreams(PDStream, PDStream, PDStream, String, String, String, PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
injectProcSetArray(PDXObjectForm, PDPage, PDResources, PDResources, PDResources, COSArray) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Inject procSetArray
injectProcSetArray(PDXObjectForm, PDPage, PDResources, PDResources, PDResources, COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
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.
inputFile - Variable in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
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.
insertCOSStream(PDStream) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
Insert the given stream at the beginning of the existing stream array.
insertInnerFormToHolerResources(PDXObjectForm, PDResources) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
insertInnerFormToHolerResources(PDXObjectForm, PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
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.encoding.EncodingManager
Default singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.MacOSRomanEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.MacRomanEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.PdfDocEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.PDFDocEncodingCharset
Singleton instance.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.StandardEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.encoding.WinAnsiEncoding
Singleton instance of this class.
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.
InstructionSequence - Class in org.apache.pdfbox.pdmodel.common.function.type4
Represents an instruction sequence, a combination of values, operands and nested procedures.
InstructionSequence() - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
 
InstructionSequenceBuilder - Class in org.apache.pdfbox.pdmodel.common.function.type4
Basic parser for Type 4 functions which is used to build up instruction sequences.
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.
INVALID_PAGE_FOR_SIGNATURE - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
INVALID_YEAR - Static variable in class org.apache.pdfbox.util.DateConverter
Error value if date is invalid.
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
 
IOUtils - Class in org.apache.pdfbox.io
This class contains various I/O-related methods.
isAddRevInfoRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isAES() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
True if AES is used for encryption and decryption.
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
Indicates if all security is removed or not when writing the pdf.
isAlphaSource() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
get the value of the stroke alpha source property.
isArticleStart() - Method in class org.apache.pdfbox.util.PositionWrapper
 
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 ).
isContinueOnError(Exception) - Method in class org.apache.pdfbox.pdfparser.PDFParser
Returns true if parsing should be continued.
isDashPatternEmpty() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Checks if the dashPattern is empty or all values equals 0.
isDecrypted() - Method in class org.apache.pdfbox.cos.COSDocument
Indicates if a encrypted pdf is already decrypted after parsing.
isDiacritic() - Method in class org.apache.pdfbox.util.TextPosition
 
isDigestMethodRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isDirect() - Method in class org.apache.pdfbox.cos.COSBase
If the state is set true, the dictionary will be written direct into the called object.
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.
isEncryptMetaData() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Will get the EncryptMetaData dictionary info.
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 .
isFDFDocment - Variable in class org.apache.pdfbox.pdfparser.PDFParser
 
isFileSelect() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
isFilterRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isFixedPitch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isFontSubstituted() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will get the value for isFontSubstituted, which indicates if the font was substituted due to a problem with the embedded one.
isForceBold() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isForceParsing() - Method in class org.apache.pdfbox.util.PDFStreamEngine
Indicates if force parsing is activated.
isFree() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
Gets the xref 'free' attribute.
isGroupEnabled(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Indicates whether an optional content group is enabled.
isHangingIndent() - Method in class org.apache.pdfbox.util.PositionWrapper
 
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.
isIgnoreAcroFormErrors() - Method in class org.apache.pdfbox.util.PDFMergerUtility
Indicates if acroform errors are ignored or not.
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.
isLandscape() - Method in class org.apache.pdfbox.TextToPDF
Tells the paper orientation.
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?
isLegalAttestationRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isLenient() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Return true if parser is lenient.
isLineStart() - Method in class org.apache.pdfbox.util.PositionWrapper
 
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
 
isNeedToBeUpdate() - Method in class org.apache.pdfbox.cos.COSBase
 
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 newline.
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, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Check for owner password.
isOwnerPassword(String, byte[], byte[], int, byte[], int, int, boolean) - 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).
isPageBreak() - Method in class org.apache.pdfbox.util.PositionWrapper
 
isParagraphSeparation(PositionWrapper, PositionWrapper, PositionWrapper, float) - Method in class org.apache.pdfbox.util.PDFTextStripper
tests the relationship between the last text position, the current text position and the last text position that followed a line separator to decide if the gap represents a paragraph separation.
isParagraphStart() - Method in class org.apache.pdfbox.util.PositionWrapper
 
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
 
isReasonRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isRecursivlyRead() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
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?
isRootNode() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Determines if this is a root node or not.
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?
isStencil() - Method in class org.apache.pdfbox.util.ImageParameters
Returns true if the image is a stencil mask.
isStrokeAdjustment() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the stroke adjustment parameter.
isSubFilterRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
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.
isSymbolicFont() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines if the font is a symbolic font.
isTimestampRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Indicates if a timestamp is required.
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?
isType0Font() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines if the font is a type 0 font.
isType1Font() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines if the font is a type 1 font.
isType3Font() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Determines if the font is a type 3 font.
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, boolean) - 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, boolean) - 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. 
isVisualSignEnabled() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
checks if we need to add visible signature
isVolatile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Get if the file is volatile.
isVRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
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.
isXRefStream() - Method in class org.apache.pdfbox.cos.COSDocument
Determines it the trailer is a XRef stream 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.
ITALIC_ANGLE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
items - Variable in class org.apache.pdfbox.cos.COSDictionary
The name-value pairs of this dictionary.
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
A common COSName value.
JBIG2_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
JBIG2_GLOBALS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
JBIG2Filter - Class in org.apache.pdfbox.filter
Modeled on the JBIG2Decode filter.
JBIG2Filter() - Constructor for class org.apache.pdfbox.filter.JBIG2Filter
 
JPX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
JPXFilter - Class in org.apache.pdfbox.filter
This is used for the JPXDecode filter.
JPXFilter() - Constructor for class org.apache.pdfbox.filter.JPXFilter
 

K

K - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
KEYWORDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
KIDS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

L

L - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
A common COSName value.
LAST_CHAR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LAST_MODIFIED - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
lastIndexOf(char[], byte[], int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Searches last appearance of pattern within buffer.
lastIndexOf(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
LayerUtility - Class in org.apache.pdfbox.util
This class allows to import pages as Form XObjects into a PDF file and use them to create layers (optional content groups).
LayerUtility(PDDocument) - Constructor for class org.apache.pdfbox.util.LayerUtility
Creates a new instance.
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.
LEADING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
leftPixel(byte[], int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
Get the left pixel from the buffer.
LEGAL_ATTESTATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LENGTH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.RandomAccessBufferedFileInputStream
 
length() - Method in class org.apache.pdfbox.io.RandomAccessFile
The total number of bytes that are available.
length() - Method in interface org.apache.pdfbox.io.RandomAccessRead
The total number of bytes that are available.
LENGTH1 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
LENGTH2 - Static variable in class org.apache.pdfbox.cos.COSName
 
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
A common COSName value.
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.
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(File) - Static method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
This will load a document from an input stream.
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.
loadNonSeq(File, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
Parses PDF with non sequential parser.
loadNonSeq(File, RandomAccess, String) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
Parses PDF with non sequential parser.
loadNonSeq(InputStream, RandomAccess) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
Parses PDF with non sequential parser.
loadNonSeq(InputStream, RandomAccess, String) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
Parses PDF with non sequential parser.
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.
loadTTF(PDDocument, InputStream, Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
This will load a TTF to be embedded into a document.
loadTTF(PDStream, Encoding) - 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.
LOCATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
log - Static variable in class org.apache.pdfbox.cos.COSDictionaryLateBinding
 
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.
LONG_MAKE_UP - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The long make-up code words.
longValue() - Method in class org.apache.pdfbox.cos.COSFloat
This will get the long 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 filter used for the LZWDecode filter.
LZWFilter() - Constructor for class org.apache.pdfbox.filter.LZWFilter
 

M

M - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
MAC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
MAC_ROMAN_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
MacOSRomanEncoding - Class in org.apache.pdfbox.encoding
This is the Mac OS Roman encoding, which is similar to the MacRomanEncoding with the addition of 15 entries
MacOSRomanEncoding() - Constructor for class org.apache.pdfbox.encoding.MacOSRomanEncoding
Constructor.
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.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.OverlayPDF
This will overlay a document and write out the results.
main(String[]) - Static method in class org.apache.pdfbox.PDFBox
Main method.
main(String[]) - Static method in class org.apache.pdfbox.PDFDebugger
 
main(String[]) - Static method in class org.apache.pdfbox.PdfDecompressor
This is a very simple program, so everything is in the main method.
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 some text in 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.
main(String[]) - Static method in class org.apache.pdfbox.WriteDecodedDoc
This will write a PDF document with completely decoded streams.
makeLineLogicalOrder(String, boolean) - Method in class org.apache.pdfbox.util.ICU4JImpl
Deprecated.
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
Deprecated.
isn't used anymore
mapCIDToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
Maps the given CID to the correspondent GID.
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() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
 
MARK_INFO - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.
markSupported() - Method in class org.apache.pdfbox.io.ccitt.CCITTFaxG31DDecodeInputStream
MASK - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
mask(BufferedImage) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
 
matchListItemPattern(PositionWrapper) - Method in class org.apache.pdfbox.util.PDFTextStripper
returns the list item Pattern object that matches the text at the specified PositionWrapper or null if the text does not match such a pattern.
matchPattern(String, List<Pattern>) - Static method in class org.apache.pdfbox.util.PDFTextStripper
iterates over the specified list of Patterns until it finds one that matches the specified string.
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.
MAX_LEN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
MAX_WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
maxBBoxX - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
maxBBoxY - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
MCID - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
MDP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.
mergeDocumentsNonSeq(RandomAccess) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Merge the list of source documents with the non sequential parser, 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.
MetaUtil - Class in org.apache.pdfbox.util
 
MetaUtil() - Constructor for class org.apache.pdfbox.util.MetaUtil
 
minBBoxX - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
minBBoxY - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
MISSING_WIDTH - 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.
MOD_DATE - 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.
multiply(Matrix, Matrix) - Method in class org.apache.pdfbox.util.Matrix
This method multiplies this Matrix with the specified other Matrix, storing the product in the specified result Matrix.

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.encoding.PDFDocEncodingCharset
Canonical name for the PDFDocEncoding.
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
A common COSName value.
nameToCode - Variable in class org.apache.pdfbox.encoding.Encoding
This is a mapping from a character name to a character code.
newDecoder() - Method in class org.apache.pdfbox.encoding.SingleByteCharset
newEncoder() - Method in class org.apache.pdfbox.encoding.SingleByteCharset
newGreg() - Static method in class org.apache.pdfbox.util.DateConverter
Construct a new GregorianCalendar and set defaults.
newLine(CharSequence) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
Indicates that a new line starts.
newLine(CharSequence) - Method in interface org.apache.pdfbox.pdmodel.common.function.type4.Parser.SyntaxHandler
Indicates that a new line starts.
NEXT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NextLine - Class in org.apache.pdfbox.util.operator
 
NextLine() - Constructor for class org.apache.pdfbox.util.operator.NextLine
 
nextXrefObj(long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Signals that a new XRef object (table or stream) starts.
NM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NO_SUCH_ALGORITHM - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
node - Variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
The dictionary for this node.
NON_EFONT_NO_WARN - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NON_FULL_SCREEN_PAGE_MODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
NON_FULL_SCREEN_PAGE_MODE_USE_NONE - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
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
 
NonSequentialPDFParser - Class in org.apache.pdfbox.pdfparser
PDFParser which first reads startxref and xref tables in order to know valid objects and parse only these objects.
NonSequentialPDFParser(String) - Constructor for class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Constructs parser for given file using memory buffer.
NonSequentialPDFParser(File, RandomAccess) - Constructor for class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Constructs parser for given file using given buffer for temporary storage.
NonSequentialPDFParser(File, RandomAccess, String) - Constructor for class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Constructs parser for given file using given buffer for temporary storage.
NonSequentialPDFParser(InputStream) - Constructor for class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Constructor.
NonSequentialPDFParser(InputStream, RandomAccess, String) - Constructor for class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Constructor.
normalizeDiac(String) - Method in class org.apache.pdfbox.util.ICU4JImpl
Deprecated.
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
Deprecated.
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.
NOTDEF - Static variable in class org.apache.pdfbox.encoding.Encoding
Identifies a non-mapped character.
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.
NullOutputStream - Class in org.apache.pdfbox.util
Dummy output stream, everything written there gets lost.
NullOutputStream() - Constructor for class org.apache.pdfbox.util.NullOutputStream
 
NUMS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

O

O - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OBJ - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OBJ - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The starting object token.
OBJ_MARKER - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
obj-marker.
OBJ_STM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OC - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the content group tag.
OCG - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for an optional content group.
OCGS - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the optional content group list.
OCPROPERTIES - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the optional content properties.
OFF - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the "OFF" value.
ON - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the "ON" value.
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
A common COSName value.
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.
Operator - Interface in org.apache.pdfbox.pdmodel.common.function.type4
Interface for PostScript operators.
OperatorProcessor - Class in org.apache.pdfbox.util.operator
 
OperatorProcessor() - Constructor for class org.apache.pdfbox.util.operator.OperatorProcessor
Constructor.
Operators - Class in org.apache.pdfbox.pdmodel.common.function.type4
This class provides all the supported operators.
Operators() - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.Operators
Creates a new Operators object with the default set of operators.
OPM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OPT - 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
 
ORDER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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.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.io.ccitt - package org.apache.pdfbox.io.ccitt
This package contains CCITT encoders and decoders.
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.common.function.type4 - package org.apache.pdfbox.pdmodel.common.function.type4
This package contains Type 4 function support.
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.optionalcontent - package org.apache.pdfbox.pdmodel.graphics.optionalcontent
 
org.apache.pdfbox.pdmodel.graphics.pattern - package org.apache.pdfbox.pdmodel.graphics.pattern
This package deals with patterns which are used instead of colors.
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.shading - package org.apache.pdfbox.pdmodel.graphics.shading
This package deals with shadings which are used for filling instead of a color.
org.apache.pdfbox.pdmodel.graphics.xobject - 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.digitalsignature.visible - package org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
This is the visual signature part that help creating the visual representation for the digital signature.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.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.markedcontent - package org.apache.pdfbox.pdmodel.markedcontent
 
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.
OS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
A common COSName value.
output - Variable in class org.apache.pdfbox.util.PDFTextStripper
The stream to write the output to.
OUTPUT_CONDITION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OUTPUT_CONDITION_IDENTIFIER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OUTPUT_INTENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
OUTPUT_INTENTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
outputColorModel - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
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.
Overlay - Class in org.apache.pdfbox.util
Adds an overlay to an existing PDF document.
Overlay() - Constructor for class org.apache.pdfbox.util.Overlay
 
overlay(Map<Integer, String>, boolean) - Method in class org.apache.pdfbox.util.Overlay
This will add overlays to a documents.
Overlay.Position - Enum in org.apache.pdfbox.util
Possible location of the overlayed pages: foreground or background.
OverlayPDF - Class in org.apache.pdfbox
Adds an overlay to an existing PDF document.
OverlayPDF() - Constructor for class org.apache.pdfbox.OverlayPDF
 
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
PackedBitArray - Class in org.apache.pdfbox.io.ccitt
Represents an array of bits packed in a byte array of fixed size.
PackedBitArray(int) - Constructor for class org.apache.pdfbox.io.ccitt.PackedBitArray
Constructs a new bit array.
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
Current page to be rendered.
page(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets page number
PAGE_LABELS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PAGE_LAYOUT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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
A common COSName value.
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.
PageExtractor - Class in org.apache.pdfbox.util
This class will extract one or more sequential pages and create a new document.
PageExtractor(PDDocument) - Constructor for class org.apache.pdfbox.util.PageExtractor
Creates a new instance of PageExtractor
PageExtractor(PDDocument, int, int) - Constructor for class org.apache.pdfbox.util.PageExtractor
Creates a new instance of PageExtractor
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
Size of the page.
pageWidth(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
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
PAINT_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
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 - 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
A common COSName value.
parse() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will parse the stream and populate the COSDocument object.
parse() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
This will parse the stream and populate the COSDocument object.
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() - Method in class org.apache.pdfbox.pdfparser.VisualSignatureParser
This will parse the tokens making up the visual signature.
parse(CharSequence) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Parses the given text into an instruction sequence representing a Type 4 function that can be executed.
parse(CharSequence, Parser.SyntaxHandler) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.Parser
Parses a Type 4 function and sends the syntactic elements to the given syntax handler.
parse(InputStream) - Static method in class org.apache.pdfbox.util.XMLUtil
This will parse an XML stream and create a DOM document.
parseBigEndianDate(String, ParsePosition) - Static method in class org.apache.pdfbox.util.DateConverter
Parses a big-endian date: year month day hour min sec.
parseBoolean() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a boolean object from the stream.
parseCmap(String, InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
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.
parseCOSStream(COSDictionary, RandomAccess) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
This will read a COSStream from the input stream using length attribute within dictionary.
parseCOSString(boolean) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Deprecated.
Not needed anymore. Use BaseParser.parseCOSString() instead. PDFBOX-1437
parseCOSString() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF string.
parseDate(String, String[], ParsePosition) - Static method in class org.apache.pdfbox.util.DateConverter
Parses a String to see if it begins with a date, and if so, returns that date.
parseDirObject() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a directory object from the stream.
parseHeader() - Method in class org.apache.pdfbox.pdfparser.PDFParser
 
parseInt(String) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Parses a value of type "int".
parseNumber(String) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
parseObjectDynamically(COSObject, boolean) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
This will parse the next object from the stream and add it to the local state.
parseObjectDynamically(int, int, boolean) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
This will parse the next object from the stream and add it to the local state.
Parser - Class in org.apache.pdfbox.pdmodel.common.function.type4
Parser for PDF Type 4 functions.
Parser.AbstractSyntaxHandler - Class in org.apache.pdfbox.pdmodel.common.function.type4
Abstract base class for a Parser.SyntaxHandler.
Parser.AbstractSyntaxHandler() - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
 
Parser.SyntaxHandler - Interface in org.apache.pdfbox.pdmodel.common.function.type4
This interface defines all possible syntactic elements of a Type 4 function.
parseReal(String) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Parses a value of type "real".
parseSimpleDate(String, String[], ParsePosition) - Static method in class org.apache.pdfbox.util.DateConverter
See if text can be parsed as a date according to any of a list of formats.
parseStartXref() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the startxref section from the stream.
parseTimeField(String, ParsePosition, int, int) - Static method in class org.apache.pdfbox.util.DateConverter
Parses an integer from a string, starting at and advancing a ParsePosition.
parseTrailer() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the trailer from the stream and add it to the state.
parseTrailerInformation() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
parseTZoffset(String, GregorianCalendar, ParsePosition) - Static method in class org.apache.pdfbox.util.DateConverter
Parses the end of a date string for a time zone and, if one is found, sets the time zone of the GregorianCalendar.
parseXrefStream(COSStream, long) - Method in class org.apache.pdfbox.pdfparser.PDFParser
Fills XRefTrailerResolver with data of given stream.
parseXrefStream(COSStream, long, boolean) - Method in class org.apache.pdfbox.pdfparser.PDFParser
Fills XRefTrailerResolver with data of given stream.
parseXrefTable(long) - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the xref table from the stream and add it to the state The XrefTable contents are ignored.
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.
PATTERN_TYPE - 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.
PDActionNamed - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This represents a named action in a PDF document.
PDActionNamed() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
Default constructor.
PDActionNamed(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
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 represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .
PDAnnotationSquareCircle(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Creates a Circle or Square annotation of the specified sub type.
PDAnnotationSquareCircle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Creates a Line annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationText - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a text annotation.
PDAnnotationText() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constructor.
PDAnnotationText(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationTextMarkup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.
PDAnnotationTextMarkup(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
Creates a TextMarkup annotation of the specified sub type.
PDAnnotationTextMarkup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationUnknown - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents an arbitary Unknown Annotation type.
PDAnnotationUnknown(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown
Creates an arbitary annotation from a COSDictionary, expected to be a correct object definition for some sort of annotation.
PDAnnotationWidget - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a widget.
PDAnnotationWidget() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Constructor.
PDAnnotationWidget(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDAppearance - Class in org.apache.pdfbox.pdmodel.interactive.form
This one took me a while, but i'm proud to say that it handles the appearance of a textbox.
PDAppearance(PDAcroForm, PDVariableText) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAppearance
Constructs a COSAppearnce from the given field.
PDAppearanceCharacteristicsDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents an appearance characteristics dictionary.
PDAppearanceCharacteristicsDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
Constructor.
PDAppearanceDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents a PDF /AP entry the appearance dictionary.
PDAppearanceDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor.
PDAppearanceDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor.
PDAppearanceStream - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents an appearance for an annotation.
PDAppearanceStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Constructor.
PDArtifactMarkedContent - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
An artifact marked content.
PDArtifactMarkedContent(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
 
PDAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
An attribute object.
PDAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Default constructor.
PDAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Creates a new attribute object with a given dictionary.
PDBorderEffectDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents a PDF /BE entry the border effect dictionary.
PDBorderEffectDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constructor.
PDBorderEffectDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constructor.
PDBorderStyleDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents a PDF /BS entry the border style dictionary.
PDBorderStyleDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constructor.
PDBorderStyleDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constructor.
PDBoxStyle - Class in org.apache.pdfbox.pdmodel.documentinterchange.prepress
The Box Style specifies visual characteristics for displaying box areas.
PDBoxStyle() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Default Constructor.
PDBoxStyle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Constructor for an existing BoxStyle element.
PDCalGray - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Cal Gray color space.
PDCalGray() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Constructor.
PDCalGray(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Constructor with array.
PDCalRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Cal RGB color space.
PDCalRGB() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Constructor.
PDCalRGB(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Constructor with array.
PDCcitt - Class in org.apache.pdfbox.pdmodel.graphics.xobject
An image class for CCITT Fax.
PDCcitt(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
Standard constructor.
PDCcitt(PDDocument, RandomAccess, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
Construct from a tiff file.
PDCcitt(PDDocument, RandomAccess) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
Construct from a tiff file.
PDCheckbox - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a checkbox.
PDCheckbox(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
 
PDChoiceButton - Class in org.apache.pdfbox.pdmodel.interactive.form
This holds common functionality for check boxes and radio buttons.
PDChoiceButton(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
 
PDChoiceField - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a choicefield.
PDChoiceField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
 
PDCIDFont - Class in org.apache.pdfbox.pdmodel.font
This is implementation for the CIDFontType0/CIDFontType2 Fonts.
PDCIDFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFont
Constructor.
PDCIDFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFont
Constructor.
PDCIDFontType0Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the CIDFontType0 Font.
PDCIDFontType0Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
Constructor.
PDCIDFontType0Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
Constructor.
PDCIDFontType2Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the CIDFontType2 Font.
PDCIDFontType2Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
Constructor.
PDCIDFontType2Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
Constructor.
PDColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a color space in a pdf document.
PDColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
 
PDColorSpaceFactory - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a color space in a pdf document.
PDColorState - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a color space and the color value for that colorspace.
PDColorState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
Default constructor.
PDColorState(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
Constructor with an existing color set.
PDComplexFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
This represents a file specification.
PDComplexFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Default Constructor.
PDComplexFileSpecification(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Constructor.
PDCryptFilterDictionary - Class in org.apache.pdfbox.pdmodel.encryption
This class is a specialized view of the crypt filter dictionary of a PDF document.
PDCryptFilterDictionary() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
creates a new empty crypt filter dictionary.
PDCryptFilterDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
creates a new crypt filter dictionary from the low level dictionary provided.
PDDefaultAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A default attribute object.
PDDefaultAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Default constructor.
PDDefaultAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Creates a default attribute object with a given dictionary.
PDDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination in a PDF document.
PDDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
 
PDDestinationNameTreeNode - Class in org.apache.pdfbox.pdmodel
This class holds all of the name trees that are available at the document level.
PDDestinationNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
Constructor.
PDDestinationNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
Constructor.
PDDestinationOrAction - Interface in org.apache.pdfbox.pdmodel.common
This is an interface used for some elements such as the document OpenAction that can be either a Destination or an Action.
PDDeviceCMYK - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a CMYK color space.
PDDeviceGray - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Gray color space.
PDDeviceGray() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
PDDeviceN - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a DeviceN color space.
PDDeviceN() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Constructor.
PDDeviceN(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Constructor.
PDDeviceNAttributes - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents attributes for a DeviceN color space.
PDDeviceNAttributes() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Constructor.
PDDeviceNAttributes(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Constructor.
PDDeviceRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents an RGB color space.
PDDictionaryWrapper - Class in org.apache.pdfbox.pdmodel.common
A wrapper for a COS dictionary.
PDDictionaryWrapper() - Constructor for class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
Default constructor
PDDictionaryWrapper(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
Creates a new instance with a given COS dictionary.
PDDocument - Class in org.apache.pdfbox.pdmodel
This is the in-memory representation of the PDF document.
PDDocument() - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor, creates a new PDF Document with no pages.
PDDocument(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocument(COSDocument, BaseParser) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocumentCatalog - Class in org.apache.pdfbox.pdmodel
This class represents the acroform of a PDF document.
PDDocumentCatalog(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Constructor.
PDDocumentCatalog(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Constructor.
PDDocumentCatalogAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
This class represents a document catalog's dictionary of actions that occur due to events.
PDDocumentCatalogAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Default constructor.
PDDocumentCatalogAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
Constructor.
PDDocumentInformation - Class in org.apache.pdfbox.pdmodel
This is the document metadata.
PDDocumentInformation() - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentInformation
Default Constructor.
PDDocumentInformation(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentInformation
Constructor that is used for a preexisting dictionary.
PDDocumentNameDestinationDictionary - Class in org.apache.pdfbox.pdmodel
This encapsulates the "dictionary of names and corresponding destinations" for the /Dest entry in the document catalog.
PDDocumentNameDestinationDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentNameDestinationDictionary
Constructor.
PDDocumentNameDictionary - Class in org.apache.pdfbox.pdmodel
This class holds all of the name trees that are available at the document level.
PDDocumentNameDictionary(PDDocumentCatalog) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Constructor.
PDDocumentNameDictionary(PDDocumentCatalog, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Constructor.
PDDocumentOutline - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
This represents an outline in a pdf document.
PDDocumentOutline() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
Default Constructor.
PDDocumentOutline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
Constructor for an existing document outline.
PDEmbeddedFile - Class in org.apache.pdfbox.pdmodel.common.filespecification
This represents an embedded file in a file specification.
PDEmbeddedFile(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFile(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Constructor.
PDEmbeddedFilesNameTreeNode - Class in org.apache.pdfbox.pdmodel
This class holds all of the name trees that are available at the document level.
PDEmbeddedFilesNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Constructor.
PDEmbeddedFilesNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
Constructor.
PDEncryptionDictionary - Class in org.apache.pdfbox.pdmodel.encryption
This class is a specialized view of the encryption dictionary of a PDF document.
PDEncryptionDictionary() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
creates a new empty encryption dictionary.
PDEncryptionDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
creates a new encryption dictionary from the low level dictionary provided.
PDEncryptionManager - Class in org.apache.pdfbox.pdmodel.encryption
Deprecated.
Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
PDExportFormatAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
An Export Format attribute object.
PDExportFormatAttributeObject(String) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Default constructor.
PDExportFormatAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Creates a new ExportFormat attribute object with a given dictionary.
PDExtendedGraphicsState - Class in org.apache.pdfbox.pdmodel.graphics
This class represents the graphics state dictionary that is stored in the PDF document.
PDExtendedGraphicsState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Default constructor, creates blank graphics state.
PDExtendedGraphicsState(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Create a graphics state from an existing dictionary.
PDExternalDataDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This class represents an external data dictionary.
PDExternalDataDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
Constructor.
PDExternalDataDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
Constructor.
PDF_DOC_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PDFBox - Class in org.apache.pdfbox
Simple wrapper around all the command line utilities included in PDFBox.
PDFBox() - Constructor for class org.apache.pdfbox.PDFBox
 
PDFBoxCharsetProvider - Class in org.apache.pdfbox.encoding
CharsetProvider implementation for publishing PDFBox's encodings.
PDFBoxCharsetProvider() - Constructor for class org.apache.pdfbox.encoding.PDFBoxCharsetProvider
Constructor.
PDFCloneUtility - Class in org.apache.pdfbox.util
Utility class used to clone PDF objects.
PDFCloneUtility(PDDocument) - Constructor for class org.apache.pdfbox.util.PDFCloneUtility
Creates a new instance for the given target document.
PDFDebugger - Class in org.apache.pdfbox
 
PDFDebugger() - Constructor for class org.apache.pdfbox.PDFDebugger
Constructor.
PdfDecompressor - Class in org.apache.pdfbox
This program will just take all of the stream objects in a PDF and dereference them.
PdfDecompressor() - Constructor for class org.apache.pdfbox.PdfDecompressor
 
PdfDocEncoding - Class in org.apache.pdfbox.encoding
This is an interface to a text encoder.
PdfDocEncoding() - Constructor for class org.apache.pdfbox.encoding.PdfDocEncoding
Constructor.
PDFDocEncodingCharset - Class in org.apache.pdfbox.encoding
Charset implementation for the "PDFDocEncoding" from the PDF specification.
PDFDocEncodingCharset() - Constructor for class org.apache.pdfbox.encoding.PDFDocEncodingCharset
Creates a new "PDFDocEncoding" charset.
pdfDocument - Variable in class org.apache.pdfbox.util.Splitter
The source PDF document.
PDFEncryption - Class in org.apache.pdfbox.encryption
Deprecated.
use the new security layer instead
PDFEncryption() - Constructor for class org.apache.pdfbox.encryption.PDFEncryption
Deprecated.
 
PDFHighlighter - Class in org.apache.pdfbox.util
Highlighting of words in a PDF document with an XML file.
PDFHighlighter() - Constructor for class org.apache.pdfbox.util.PDFHighlighter
Default constructor.
PDField - Class in org.apache.pdfbox.pdmodel.interactive.form
This is the superclass for a Field element in a PDF.
PDField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDField
Constructor.
PDField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDField
Creates a COSField from a COSDictionary, expected to be a correct object definition for a field in PDF.
PDFieldFactory - Class in org.apache.pdfbox.pdmodel.interactive.form
This is the Factory for creating and returning the correct field elements.
PDFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
This represents a file specification.
PDFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
 
PDFImageWriter - Class in org.apache.pdfbox.util
This class writes single pages of a pdf to a file.
PDFImageWriter() - Constructor for class org.apache.pdfbox.util.PDFImageWriter
Instantiate a new PDFImageWriter object.
PDFImageWriter(Properties) - Constructor for class org.apache.pdfbox.util.PDFImageWriter
Instantiate a new PDFImageWriter object.
PDFMarkedContentExtractor - Class in org.apache.pdfbox.util
This is an stream engine to extract the marked content of a pdf.
PDFMarkedContentExtractor() - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
Instantiate a new PDFTextStripper object.
PDFMarkedContentExtractor(Properties) - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
Instantiate a new PDFTextStripper object.
PDFMarkedContentExtractor(String) - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
Instantiate a new PDFTextStripper object.
PDFMerger - Class in org.apache.pdfbox
This is the main program that will take a list of pdf documents and merge them, saving the result in a new document.
PDFMergerUtility - Class in org.apache.pdfbox.util
This class will take a list of pdf documents and merge them, saving the result in a new document.
PDFMergerUtility() - Constructor for class org.apache.pdfbox.util.PDFMergerUtility
Instantiate a new PDFMergerUtility.
PDFObjectStreamParser - Class in org.apache.pdfbox.pdfparser
This will parse a PDF 1.5 object stream and extract all of the objects from the stream.
PDFObjectStreamParser(COSStream, COSDocument, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
Constructor.
PDFObjectStreamParser(COSStream, COSDocument) - Constructor for class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
Constructor.
PDFont - Class in org.apache.pdfbox.pdmodel.font
This is the base class for all PDF fonts.
PDFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFont
Constructor.
PDFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFont
Constructor.
PDFontDescriptor - Class in org.apache.pdfbox.pdmodel.font
This class represents an interface to the font description.
PDFontDescriptor() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
 
PDFontDescriptorAFM - Class in org.apache.pdfbox.pdmodel.font
This class represents the font descriptor when the font information is coming from an AFM file.
PDFontDescriptorAFM(FontMetric) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
Constructor.
PDFontDescriptorDictionary - Class in org.apache.pdfbox.pdmodel.font
This class represents an implementation to the font descriptor that gets its information from a COS Dictionary.
PDFontDescriptorDictionary() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Constructor.
PDFontDescriptorDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Constructor.
PDFontFactory - Class in org.apache.pdfbox.pdmodel.font
This will create the correct type of font based on information in the dictionary.
PDFontSetting - Class in org.apache.pdfbox.pdmodel.graphics
This class represents a font setting used for the graphics state.
PDFontSetting() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
Creates a blank font setting, font will be null, size will be 1.
PDFontSetting(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
Constructs a font setting from an existing array.
PDFOperator - Class in org.apache.pdfbox.util
This class represents an Operator in the content stream.
PDFormFieldAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
This class represents a form field's dictionary of actions that occur due to events.
PDFormFieldAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Default constructor.
PDFormFieldAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
Constructor.
PDFourColours - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
An object for four colours.
PDFourColours() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
 
PDFourColours(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
 
PDFPagePanel - Class in org.apache.pdfbox.pdfviewer
This is a simple JPanel that can be used to display a PDF page.
PDFPagePanel() - Constructor for class org.apache.pdfbox.pdfviewer.PDFPagePanel
Constructor.
PDFParser - Class in org.apache.pdfbox.pdfparser
This class will handle the parsing of the PDF document.
PDFParser(InputStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor.
PDFParser(InputStream, RandomAccess) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor to allow control over RandomAccessFile.
PDFParser(InputStream, RandomAccess, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor to allow control over RandomAccessFile.
PDFReader - Class in org.apache.pdfbox
An application to read PDF documents.
PDFReader() - Constructor for class org.apache.pdfbox.PDFReader
Constructor.
pdfSource - Variable in class org.apache.pdfbox.pdfparser.BaseParser
This is the stream that will be read from.
PDFSplit - Class in org.apache.pdfbox
This is the main program that will take a pdf document and split it into a number of other documents.
PDFStreamEngine - Class in org.apache.pdfbox.util
This class will run through a PDF content stream and execute certain operations and provide a callback interface for clients that want to do things with the stream.
PDFStreamEngine() - Constructor for class org.apache.pdfbox.util.PDFStreamEngine
Constructor.
PDFStreamEngine(Properties) - Constructor for class org.apache.pdfbox.util.PDFStreamEngine
Constructor with engine properties.
PDFStreamParser - Class in org.apache.pdfbox.pdfparser
This will parse a PDF byte stream and extract operands and such.
PDFStreamParser(InputStream, RandomAccess, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor that takes a stream to parse.
PDFStreamParser(InputStream, RandomAccess) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor that takes a stream to parse.
PDFStreamParser(PDStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFStreamParser(COSStream, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFStreamParser(COSStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFTemplateBuilder - Interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
That class builds visible signature template which will be added in our pdf document
PDFTemplateCreator - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Using that class, we build pdf template
PDFTemplateCreator(PDFTemplateBuilder) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateCreator
sets PDFBuilder
PDFTemplateStructure - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Structure of PDF document with visible signature
PDFTemplateStructure() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
 
PDFText2HTML - Class in org.apache.pdfbox.util
Wrap stripped text in simple HTML, trying to form HTML paragraphs.
PDFText2HTML(String) - Constructor for class org.apache.pdfbox.util.PDFText2HTML
Constructor.
PDFTextStripper - Class in org.apache.pdfbox.util
This class will take a pdf document and strip out all of the text and ignore the formatting and such.
PDFTextStripper() - Constructor for class org.apache.pdfbox.util.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripper(Properties) - Constructor for class org.apache.pdfbox.util.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripper(String) - Constructor for class org.apache.pdfbox.util.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripperByArea - Class in org.apache.pdfbox.util
This will extract text from a specified region in the PDF.
PDFTextStripperByArea() - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
Constructor.
PDFTextStripperByArea(Properties) - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
Instantiate a new PDFTextStripperArea object.
PDFTextStripperByArea(String) - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
Instantiate a new PDFTextStripperArea object.
PDFToImage - Class in org.apache.pdfbox
Convert a PDF document to an image.
PDFTreeCellRenderer - Class in org.apache.pdfbox.pdfviewer
A class to render tree cells for the pdfviewer.
PDFTreeCellRenderer() - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeCellRenderer
 
PDFTreeModel - Class in org.apache.pdfbox.pdfviewer
A class to model a PDF document as a tree structure.
PDFTreeModel() - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeModel
constructor.
PDFTreeModel(PDDocument) - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeModel
Constructor to take a document.
PDFunction - Class in org.apache.pdfbox.pdmodel.common.function
This class represents a function in a PDF document.
PDFunction(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunction
Constructor.
PDFunctionType0 - Class in org.apache.pdfbox.pdmodel.common.function
This class represents a type 0 function in a PDF document.
PDFunctionType0(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Constructor.
PDFunctionType2 - Class in org.apache.pdfbox.pdmodel.common.function
This class represents a type 2 function in a PDF document.
PDFunctionType2(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
Constructor.
PDFunctionType3 - Class in org.apache.pdfbox.pdmodel.common.function
This class represents a type 3 function in a PDF document.
PDFunctionType3(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Constructor.
PDFunctionType4 - Class in org.apache.pdfbox.pdmodel.common.function
This class represents a type 4 function in a PDF document.
PDFunctionType4(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
Constructor.
PDFXRef - Interface in org.apache.pdfbox.pdfparser
 
PDFXRefStream - Class in org.apache.pdfbox.pdfparser
 
PDFXRefStream() - Constructor for class org.apache.pdfbox.pdfparser.PDFXRefStream
Create a fresh XRef stream like for a fresh file or an incremental update.
PDFXrefStreamParser - Class in org.apache.pdfbox.pdfparser
This will parse a PDF 1.5 (or better) Xref stream and extract the xref information from the stream.
PDFXrefStreamParser(COSStream, COSDocument, boolean, XrefTrailerResolver) - Constructor for class org.apache.pdfbox.pdfparser.PDFXrefStreamParser
Constructor.
PDGamma - Class in org.apache.pdfbox.pdmodel.graphics.color
A gamma array, or collection of three floating point parameters used for color operations.
PDGamma() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Constructor.
PDGamma(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Constructor from COS object.
PDGraphicsState - Class in org.apache.pdfbox.pdmodel.graphics
This class will hold the current state of the graphics parameters when executing a content stream.
PDGraphicsState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Default constructor.
PDGraphicsState(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Constructor with a given pagesize to initialize the clipping path.
PDICCBased - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a ICC profile color space.
PDICCBased(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Default constructor, creates empty stream.
PDICCBased(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Constructor.
PDIndexed - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents an Indexed color space.
PDIndexed() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Constructor, default DeviceRGB, hival 255.
PDIndexed(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Constructor.
PDInlinedImage - Class in org.apache.pdfbox.pdmodel.graphics.xobject
This class represents an inlined image.
PDInlinedImage() - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
 
PDJavascriptNameTreeNode - Class in org.apache.pdfbox.pdmodel
This class holds all of the name trees that are available at the document level.
PDJavascriptNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
Constructor.
PDJavascriptNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
Constructor.
PDJpeg - Class in org.apache.pdfbox.pdmodel.graphics.xobject
An image class for JPegs.
PDJpeg(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Standard constructor.
PDJpeg(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Construct from a stream.
PDJpeg(PDDocument, BufferedImage) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Construct from a buffered image.
PDJpeg(PDDocument, BufferedImage, float) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
Construct from a buffered image.
PDLab - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Lab color space.
PDLab() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Constructor.
PDLab(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Constructor with array.
PDLayoutAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
A Layout attribute object.
PDLayoutAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Default constructor.
PDLayoutAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Creates a new Layout attribute object with a given dictionary.
PDLineDashPattern - Class in org.apache.pdfbox.pdmodel.graphics
This class represents the line dash pattern for a graphics state.
PDLineDashPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Creates a blank line dash pattern.
PDLineDashPattern(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Constructs a line dash pattern from an existing array.
PDLineDashPattern(COSArray, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Constructs a line dash pattern from an existing array.
PDListAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
A List attribute object.
PDListAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
Default constructor.
PDListAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
Creates a new List attribute object with a given dictionary.
PDMarkedContent - Class in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent
A marked content.
PDMarkedContent(COSName, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Creates a new marked content object.
PDMarkedContentReference - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A marked-content reference.
PDMarkedContentReference() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Default constructor
PDMarkedContentReference(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Constructor for an existing marked content reference.
PDMarkInfo - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
The MarkInfo provides additional information relevant to specialized uses of structured documents.
PDMarkInfo() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Default Constructor.
PDMarkInfo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Constructor for an existing MarkInfo element.
PDMatrix - Class in org.apache.pdfbox.pdmodel.common
This class will be used for matrix manipulation.
PDMatrix() - Constructor for class org.apache.pdfbox.pdmodel.common.PDMatrix
Constructor.
PDMatrix(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMatrix
Constructor.
PDMeasureDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
This class represents a measure dictionary.
PDMeasureDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
Constructor.
PDMeasureDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
Constructor.
PDMemoryStream - Class in org.apache.pdfbox.pdmodel.common
A PDStream represents a stream in a PDF document.
PDMemoryStream(byte[]) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will create a new PDStream object.
PDMetadata - Class in org.apache.pdfbox.pdmodel.common
This class represents metadata for various objects in a PDF document.
PDMetadata(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
This will create a new PDMetadata object.
PDMetadata(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
Constructor.
PDMetadata(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
Constructor.
PDMMType1Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the Multiple Master Type1 Font.
PDMMType1Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDMMType1Font
Constructor.
PDMMType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDMMType1Font
Constructor.
PDNamedDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page by referencing it with a name.
PDNamedDestination(COSString) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Constructor.
PDNamedDestination(COSName) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Constructor.
PDNamedDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Default constructor.
PDNamedDestination(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Default constructor.
PDNamedTextStream - Class in org.apache.pdfbox.pdmodel.common
A named text stream is a combination of a name and a PDTextStream object.
PDNamedTextStream() - Constructor for class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
Constructor.
PDNamedTextStream(COSName, COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
Constructor.
PDNameTreeNode - Class in org.apache.pdfbox.pdmodel.common
This class represents a PDF Name tree.
PDNameTreeNode(Class<? extends COSObjectable>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNameTreeNode(COSDictionary, Class<? extends COSObjectable>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNumberFormatDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
This class represents a number format dictionary.
PDNumberFormatDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constructor.
PDNumberFormatDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
Constructor.
PDNumberTreeNode - Class in org.apache.pdfbox.pdmodel.common
This class represents a PDF Number tree.
PDNumberTreeNode(Class<? extends COSObjectable>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Constructor.
PDNumberTreeNode(COSDictionary, Class<? extends COSObjectable>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Constructor.
PDObjectReference - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
An object reference.
PDObjectReference() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Default Constructor.
PDObjectReference(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Constructor for an existing object reference.
PDObjectStream - Class in org.apache.pdfbox.pdmodel.common
A PDStream represents a stream in a PDF document.
PDObjectStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDObjectStream
Constructor.
PDOptionalContentGroup - Class in org.apache.pdfbox.pdmodel.graphics.optionalcontent
This class represents an optional content group (OCG).
PDOptionalContentGroup(String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
Creates a new optional content group (OCG).
PDOptionalContentGroup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
Creates a new instance based on a given COSDictionary.
PDOptionalContentProperties - Class in org.apache.pdfbox.pdmodel.graphics.optionalcontent
This class represents the optional content properties dictionary.
PDOptionalContentProperties() - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Creates a new optional content properties dictionary.
PDOptionalContentProperties(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Creates a new instance based on a given COSDictionary.
PDOptionalContentProperties.BaseState - Enum in org.apache.pdfbox.pdmodel.graphics.optionalcontent
Enumeration for the BaseState dictionary entry on the "D" dictionary.
PDOutlineItem - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
This represents an outline in a pdf document.
PDOutlineItem() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Default Constructor.
PDOutlineItem(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Constructor for an existing outline item.
PDOutlineNode - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
This represents an node in an outline in a pdf document.
PDOutlineNode() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Default Constructor.
PDOutlineNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Default Constructor.
PDOutputIntent - Class in org.apache.pdfbox.pdmodel.graphics.color
 
PDOutputIntent(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
PDOutputIntent(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
PDPage - Class in org.apache.pdfbox.pdmodel
This represents a single page in a PDF document.
PDPage() - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage with a size of 8.5x11.
PDPage(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage.
PDPage(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage.
PDPageable - Class in org.apache.pdfbox.pdmodel
Adapter class that implements the Pageable and Printable interfaces for printing a given PDF document.
PDPageable(PDDocument, PrinterJob) - Constructor for class org.apache.pdfbox.pdmodel.PDPageable
Creates a Pageable adapter for the given PDF document and printer job.
PDPageable(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDPageable
Creates a Pageable adapter for the given PDF document using a default printer job returned by PrinterJob.getPrinterJob().
PDPageAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
This class represents a page object's dictionary of actions that occur due to events.
PDPageAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Default constructor.
PDPageAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
Constructor.
PDPageContentStream - Class in org.apache.pdfbox.pdmodel.edit
This class is a convenience for creating page content streams.
PDPageContentStream(PDDocument, PDPage) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDPage, boolean, boolean) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDPage, boolean, boolean, boolean) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Create a new PDPage content stream.
PDPageDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page, see subclasses for specific parameters.
PDPageDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Constructor to create empty page destination.
PDPageDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Constructor to create empty page destination.
PDPageFitDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page and the page contents will be magnified to just fit on the screen.
PDPageFitDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Default constructor.
PDPageFitDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Constructor from an existing destination array.
PDPageFitHeightDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page at a x location and the height is magnified to just fit on the screen.
PDPageFitHeightDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Default constructor.
PDPageFitHeightDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Constructor from an existing destination array.
PDPageFitRectangleDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page at a y location and the width is magnified to just fit on the screen.
PDPageFitRectangleDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Default constructor.
PDPageFitRectangleDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Constructor from an existing destination array.
PDPageFitWidthDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page at a y location and the width is magnified to just fit on the screen.
PDPageFitWidthDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Default constructor.
PDPageFitWidthDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Constructor from an existing destination array.
PDPageLabelRange - Class in org.apache.pdfbox.pdmodel.common
Contains information for a page label range.
PDPageLabelRange() - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Creates a new empty page label range object.
PDPageLabelRange(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Creates a new page label range object from the given dictionary.
PDPageLabels - Class in org.apache.pdfbox.pdmodel.common
Represents the page label dictionary of a document.
PDPageLabels(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabels
Creates an empty page label dictionary for the given document.
PDPageLabels(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabels
Creates an page label dictionary for a document using the information in the given COS dictionary.
PDPageNode - Class in org.apache.pdfbox.pdmodel
This represents a page node in a pdf document.
PDPageNode() - Constructor for class org.apache.pdfbox.pdmodel.PDPageNode
Creates a new instance of PDPage.
PDPageNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPageNode
Creates a new instance of PDPage.
PDPageXYZDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
This represents a destination to a page at an x,y coordinate with a zoom setting.
PDPageXYZDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Default constructor.
PDPageXYZDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Constructor from an existing destination array.
PDPattern - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Pattern color space.
PDPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Default constructor.
PDPattern(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Constructor.
PDPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
This represents the resources for a pattern colorspace.
PDPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Default constructor.
PDPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Prepopulated pattern resources.
PDPixelMap - Class in org.apache.pdfbox.pdmodel.graphics.xobject
This class contains a PixelMap Image.
PDPixelMap(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Standard constructor.
PDPixelMap(PDDocument, BufferedImage) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Construct a pixel map image from an AWT image.
PDPrintFieldAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
A PrintField attribute object.
PDPrintFieldAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Default constructor.
PDPrintFieldAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Creates a new PrintField attribute object with a given dictionary.
PDPropBuild - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This represents a pdf signature build dictionary as specified in http://partners.adobe.com/public/developer/en/acrobat/Acrobat_Signature_BuildDict.pdf The signature build properties dictionary provides signature properties for the software application that was used to create the signature.
PDPropBuild() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Default constructor.
PDPropBuild(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Constructor.
PDPropBuildDataDict - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This represents the general property dictionaries from the build property dictionary.
PDPropBuildDataDict() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Default constructor.
PDPropBuildDataDict(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Constructor.
PDPropertyList - Class in org.apache.pdfbox.pdmodel.markedcontent
This class represents a property list used for the marked content feature to map a resource name to a dictionary.
PDPropertyList() - Constructor for class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
Creates a new property list.
PDPropertyList(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
Creates a new instance based on a given COSDictionary.
PDPushButton - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a PDPushButton.
PDPushButton(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
PDRadioCollection - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a Radio Collection.
PDRadioCollection(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
 
PDRange - Class in org.apache.pdfbox.pdmodel.common
This class will be used to signify a range.
PDRange() - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
Constructor with an initial range of 0..1.
PDRange(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
Constructor assumes a starting index of 0.
PDRange(COSArray, int) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
Constructor with an index into an array.
PDRectangle - Class in org.apache.pdfbox.pdmodel.common
This represents a rectangle in a PDF document.
PDRectangle() - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(float, float) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(BoundingBox) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectangle(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
Constructor.
PDRectlinearMeasureDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
This class represents a rectlinear measure dictionary.
PDRectlinearMeasureDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
Constructor.
PDRectlinearMeasureDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
Constructor.
PDResources - Class in org.apache.pdfbox.pdmodel
This represents a set of resources available at the page/pages/stream level.
PDResources() - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Default constructor.
PDResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Prepopulated resources.
PDSeedValue - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This represents a pdf signature seed value dictionary.
PDSeedValue() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
Default constructor.
PDSeedValue(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
Constructor.
PDSeedValueMDP - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This MDP dictionary is a part of the seed value dictionary and define if a author signature or a certification signature should be use.
PDSeedValueMDP() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Default constructor.
PDSeedValueMDP(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Constructor.
PDSeedValueTimeStamp - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
If exist, it describe where the signature handler can request a rfc3161 timestamp and if it is a must have for the signature.
PDSeedValueTimeStamp() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Default constructor.
PDSeedValueTimeStamp(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Constructor.
PDSeparation - Class in org.apache.pdfbox.pdmodel.graphics.color
This class represents a Separation color space.
PDSeparation() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Constructor.
PDSeparation(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Constructor.
PDShading - Class in org.apache.pdfbox.pdmodel.graphics
This class represents a Shading Pattern color space.
PDShading() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDShading
Default constructor.
PDShading(COSName, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDShading
Constructor.
PDShadingPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
This represents the resources for a shading pattern.
PDShadingPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
Default constructor.
PDShadingPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
Prepopulated pattern resources.
PDShadingResources - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a shading.
PDShadingResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Default constructor.
PDShadingResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
Constructor using the given shading dictionary.
PDShadingType1 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a function based shading.
PDShadingType1(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
Constructor using the given shading dictionary.
PDShadingType2 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for an axial shading.
PDShadingType2(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
Constructor using the given shading dictionary.
PDShadingType3 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a radial shading.
PDShadingType3(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
Constructor using the given shading dictionary.
PDShadingType4 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Meshes).
PDShadingType4(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
Constructor using the given shading dictionary.
PDShadingType5 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a shading type 5 (Lattice-Form Gouraud-Shaded Triangle Meshes).
PDShadingType5(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
Constructor using the given shading dictionary.
PDShadingType6 - Class in org.apache.pdfbox.pdmodel.graphics.shading
Resources for a shading type 6 (Coons Patch Mesh).
PDShadingType6(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
Constructor using the given shading dictionary.
PDShadingType7 - Class in org.apache.pdfbox.pdmodel.graphics.shading
This represents resources for a shading type 7 (Tensor-Product Patch Meshes).
PDShadingType7(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
Constructor using the given shading dictionary.
PDSignature - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This represents a digital signature that can be attached to a document.
PDSignature() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Default constructor.
PDSignature(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Constructor.
PDSignature - Class in org.apache.pdfbox.pdmodel.interactive.form
Deprecated.
Use PDSignatureField instead (see PDFBOX-1513).
PDSignature(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
Deprecated.
 
PDSignatureField - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a signature.
PDSignatureField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
 
PDSignatureField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
 
PDSimpleFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
A file specification that is just a string.
PDSimpleFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Constructor.
PDSimpleFileSpecification(COSString) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
Constructor.
PDSimpleFont - Class in org.apache.pdfbox.pdmodel.font
This class contains implementation details of the simple pdf fonts.
PDSimpleFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Constructor.
PDSimpleFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Constructor.
PDStandardAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
A standard attribute object.
PDStandardAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Default constructor.
PDStandardAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Creates a new standard attribute object with a given dictionary.
PDStandardEncryption - Class in org.apache.pdfbox.pdmodel.encryption
Deprecated.
Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
PDStandardEncryption() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Default constructor that uses Version 2, Revision 3, 40 bit encryption, all permissions allowed.
PDStandardEncryption(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Constructor from existing dictionary.
PDStream - Class in org.apache.pdfbox.pdmodel.common
A PDStream represents a stream in a PDF document.
PDStream() - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
This will create a new PDStream object.
PDStream(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
This will create a new PDStream object.
PDStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStructureElement - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A structure element.
PDStructureElement(String, PDStructureNode) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Constructor with required values.
PDStructureElement(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Constructor for an existing structure element.
PDStructureNode - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A node in the structure tree.
PDStructureNode(String) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Constructor.
PDStructureNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Constructor for an existing structure node.
PDStructureTreeRoot - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A root of a structure tree.
PDStructureTreeRoot() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Default Constructor.
PDStructureTreeRoot(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Constructor for an existing structure element.
PDTableAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
A Table attribute object.
PDTableAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Default constructor.
PDTableAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Creates a new Table attribute object with a given dictionary.
PDTextbox - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling the PDF field as a textbox.
PDTextbox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
 
PDTextbox(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
 
PDTextState - Class in org.apache.pdfbox.pdmodel.text
This class will hold the current state of the text parameters when executing a content stream.
PDTextState() - Constructor for class org.apache.pdfbox.pdmodel.text.PDTextState
 
PDTextStream - Class in org.apache.pdfbox.pdmodel.common
A PDTextStream class is used when the PDF specification supports either a string or a stream for the value of an object.
PDTextStream(COSString) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDTextStream(String) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDTextStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
Constructor.
PDThread - Class in org.apache.pdfbox.pdmodel.interactive.pagenavigation
This a single thread in a PDF document.
PDThread(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Constructor that is used for a preexisting dictionary.
PDThread() - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Default constructor.
PDThreadBead - Class in org.apache.pdfbox.pdmodel.interactive.pagenavigation
This a single bead in a thread in a PDF document.
PDThreadBead(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Constructor that is used for a preexisting dictionary.
PDThreadBead() - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Default constructor.
PDTilingPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
This represents the resources for a tiling pattern.
PDTilingPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
Default constructor.
PDTilingPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
Prepopulated pattern resources.
PDTristimulus - Class in org.apache.pdfbox.pdmodel.graphics.color
A tristimulus, or collection of three floating point parameters used for color operations.
PDTristimulus() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor.
PDTristimulus(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor from COS object.
PDTristimulus(float[]) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Constructor from COS object.
PDTrueTypeFont - Class in org.apache.pdfbox.pdmodel.font
This is the TrueType implementation of fonts.
PDTrueTypeFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Constructor.
PDTrueTypeFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Constructor.
PDType0Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the Type0 Font.
PDType0Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType0Font
Constructor.
PDType0Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType0Font
Constructor.
PDType1AfmPfbFont - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the Type1 Font with a afm and a pfb file.
PDType1AfmPfbFont(PDDocument, String) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
Create a new object.
PDType1AfmPfbFont(PDDocument, InputStream, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
Create a new object.
PDType1CFont - Class in org.apache.pdfbox.pdmodel.font
This class represents a CFF/Type2 Font (aka Type1C Font).
PDType1CFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1CFont
Constructor.
PDType1Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the Type1 Font.
PDType1Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType1Font(String) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Constructor.
PDType3Font - Class in org.apache.pdfbox.pdmodel.font
This is implementation of the Type3 Font.
PDType3Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3Font
Constructor.
PDType3Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3Font
Constructor.
PDTypedDictionaryWrapper - Class in org.apache.pdfbox.pdmodel.common
A wrapper for a COS dictionary including Type information.
PDTypedDictionaryWrapper(String) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
Creates a new instance with a given type.
PDTypedDictionaryWrapper(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
Creates a new instance with a given COS dictionary.
PDUnknownField - Class in org.apache.pdfbox.pdmodel.interactive.form
This class represents a form field with an unknown type.
PDUnknownField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
 
PDURIDictionary - Class in org.apache.pdfbox.pdmodel.interactive.action.type
This is the implementation of an URI dictionary.
PDURIDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
Constructor.
PDURIDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
Constructor.
PDUserAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A User attribute object.
PDUserAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Default constructor
PDUserAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
 
PDUserProperty - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
A user property.
PDUserProperty(PDUserAttributeObject) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Creates a new user property.
PDUserProperty(COSDictionary, PDUserAttributeObject) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Creates a user property with a given dictionary.
PDVariableText - Class in org.apache.pdfbox.pdmodel.interactive.form
A class for handling PDF fields that display text.
PDVariableText(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
PDVariableText(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
PDViewerPreferences - Class in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
This is the document viewing preferences.
PDViewerPreferences(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Constructor that is used for a preexisting dictionary.
PDViewerPreferences.BOUNDARY - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Enumeration containing all valid values for boundaries.
PDViewerPreferences.DUPLEX - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Enumeration containing all valid values for duplex.
PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Enumeration containing all valid values for NonFullScreenPageMode.
PDViewerPreferences.PRINT_SCALING - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Enumeration containing all valid values for printscaling.
PDViewerPreferences.READING_DIRECTION - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Enumeration containing all valid values for ReadingDirection.
PDViewportDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
This class represents a viewport dictionary.
PDViewportDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
Constructor.
PDViewportDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
Constructor.
PDVisibleSigBuilder - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
That's implementation of PDFTemplateBuilder
PDVisibleSigBuilder() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
PDVisibleSignDesigner - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
That class is in order to build your visible signature design.
PDVisibleSignDesigner(InputStream, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
PDVisibleSignDesigner(String, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
PDVisibleSignDesigner(PDDocument, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
PDVisibleSigProperties - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
This builder class is in order to create visible signature properties.
PDVisibleSigProperties() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
 
PDWindowsLaunchParams - Class in org.apache.pdfbox.pdmodel.interactive.action.type
Launch paramaters for the windows OS.
PDWindowsLaunchParams() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Default constructor.
PDWindowsLaunchParams(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Constructor.
PDXFA - Class in org.apache.pdfbox.pdmodel.interactive.form
This class represents an XML Forms Architecture Data packet.
PDXFA(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
Constructor.
PDXObject - Class in org.apache.pdfbox.pdmodel.graphics.xobject
The base class for all XObjects in the PDF document.
PDXObject(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constructor.
PDXObject(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constuctor.
PDXObject(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Standard constuctor.
PDXObjectForm - Class in org.apache.pdfbox.pdmodel.graphics.xobject
A form xobject.
PDXObjectForm(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Standard constuctor.
PDXObjectForm(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Standard constuctor.
PDXObjectImage - Class in org.apache.pdfbox.pdmodel.graphics.xobject
The prototype for all PDImages.
PDXObjectImage(PDStream, String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Standard constructor.
PDXObjectImage(PDDocument, String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Standard constuctor.
peek() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
This will peek at the next byte.
peek() - Method in class org.apache.pdfbox.io.PushBackInputStream
This will peek at the next byte.
PG - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PLACEMENT_BEFORE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Placement: Before: Placed so that the before edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.
PLACEMENT_BLOCK - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Placement: Block: Stacked in the block-progression direction within an enclosing reference area or parent BLSE.
PLACEMENT_END - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Placement: End: Placed so that the end edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.
PLACEMENT_INLINE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Placement: Inline: Packed in the inline-progression direction within an enclosing BLSE.
PLACEMENT_START - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Placement: Start: Placed so that the start edge of the element's allocation rectangle coincides with that of the nearest enclosing reference area.
popInt() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Pops a value of type int from the stack.
popNumber() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Pops a number (int or real) from the stack.
popReal() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Pops a number from the stack and returns it as a real value.
populateBuffer(InputStream, byte[]) - Static method in class org.apache.pdfbox.io.IOUtils
Populates the given buffer with data read from the input stream.
PositionWrapper - Class in org.apache.pdfbox.util
wrapper of TextPosition that adds flags to track status as linestart and paragraph start positions.
PositionWrapper(TextPosition) - Constructor for class org.apache.pdfbox.util.PositionWrapper
Constructs a PositionWrapper around the specified TextPosition object.
potentiallyNotifyChanged(COSBase, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Notifies the attribute object change listeners if the attribute is changed.
PRE_RELEASE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PREDICTOR - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Predictor - Class in org.apache.pdfbox.filter
Helper class to contain predictor decoding used by Flate and LZW filter.
Predictor() - Constructor for class org.apache.pdfbox.filter.Predictor
 
PredictorAlgorithm - Class in org.apache.pdfbox.pdmodel.graphics.predictor
Implements different PNG predictor algorithms that is used in PDF files.
PredictorAlgorithm() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
preferredSize(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets our preferred size
prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Prepare the document for encryption.
prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Prepare the document for encryption.
prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Prepare document for encryption.
prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Prepares everything to decrypt the document.
prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Prepares everything to decrypt the document.
prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Prepares everything to decrypt the document.
PREV - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
print() - Method in class org.apache.pdfbox.cos.COSDocument
This will print contents to stdout.
print(PrinterJob) - Method in class org.apache.pdfbox.pdmodel.PDDocument
 
print() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will send the PDF document to a printer.
print(Graphics, PageFormat, int) - Method in class org.apache.pdfbox.pdmodel.PDPage
Deprecated.
Use the PDPageable adapter class
print(Graphics, PageFormat, int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
Prints the page at the given index.
PRINT_AREA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PRINT_CLIP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PRINT_SCALING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PrintPDF - Class in org.apache.pdfbox
This is a command line program that will print a PDF document.
PRIVATE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Private
PROC_SET - Static variable in class org.apache.pdfbox.cos.COSName
The COSName value for "ProcSet".
PROC_SET - Static variable in class org.apache.pdfbox.Overlay
Deprecated.
use the COSName.PROC_SET constant instead
proceedDecryption() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This method must be called by an implementation of this class to really proceed to decryption.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginMarkedContentSequence
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginMarkedContentSequenceWithProperties
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginText
process : BT : Begin text object.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.CloseAndStrokePath
s close and stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.Concatenate
process : cm : Concatenate matrix to current transformation matrix.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.EndMarkedContentSequence
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.EndText
process : ET : End text object.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.GRestore
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.GSave
process : q : Save graphics state.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.Invoke
process : Do - Invoke a named xobject.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveAndShow
' Move to next line and show text.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveText
process : Td : Move text position.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveTextSetLeading
process : TD Move text position and set leading.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.NextLine
process : T* Move to start of next text line.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.AppendRectangleToPath
process : re : append rectangle to path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.BeginInlineImage
process : BI : begin inline image.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClipEvenOddRule
process : W* : set clipping path using even odd rule.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClipNonZeroRule
process : W : Set the clipping path using non zero winding rule.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CloseFillEvenOddAndStrokePath
fill and stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CloseFillNonZeroAndStrokePath
fill and stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClosePath
process : h : Close path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveTo
process : c : Append curved segment to path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint
process : y : Append curved segment to path (final point replicated).
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint
process : v : Append curved segment to path (initial point replicated).
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.EndPath
process : n : End path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddAndStrokePath
fill and stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddRule
process : f* : fill path using even odd rule.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroAndStrokePath
fill and stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroRule
process : F/f : fill path using non zero winding rule.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.Invoke
process : Do : Paint the specified XObject (section 4.7).
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.LineTo
process : l : Append straight line segment to path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.MoveTo
process : m : Begin new subpath.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineCapStyle
Set the line cap style.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineDashPattern
Set the line dash pattern.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineJoinStyle
Set the line cap style.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineMiterLimit
Set the line dash pattern.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineWidth
w Set line width.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SHFill
process : sh : shade fill the clipping area.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.StrokePath
S stroke the path.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetCharSpacing
process : Tc Set character spacing.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetGraphicsStateParameters
gs Set parameters from graphics state parameter dictionary.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetHorizontalTextScaling
Tz Set horizontal text scaling.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineCapStyle
Set the line cap style.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineDashPattern
Set the line dash pattern.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineJoinStyle
Set the line cap style.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineMiterLimit
w Set miter limit.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineWidth
w Set line width.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetMatrix
Tm Set text matrix and text line matrix.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetMoveAndShow
" Set word and character spacing, move to next line, and show text.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingCalRGBColor
rg Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingCMYKColor
k Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingColor
sc,scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingColorSpace
cs Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingDeviceN
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingGrayColor
rg Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingICCBasedColor
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingIndexed
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingLabColor
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingPattern
Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingRGBColor
rg Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingSeparation
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingCalRGBColor
RG Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingCMYKColor
K Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingColor
SC,SCN Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingColorSpace
CS Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingDeviceN
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingGrayColor
RG Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingICCBasedColor
scn Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingIndexed
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingLabColor
process the operator.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingPattern
Set pattern instead of a color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingRGBColor
RG Set color space for stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingSeparation
scn Set color space for non stroking operations.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextFont
Tf selectfont Set text font and size.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextLeading
TL Set text leading.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextRenderingMode
Tr Set text rendering mode.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextRise
Ts Set text rise.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetWordSpacing
Tw Set word spacing.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.ShowText
Tj show Show text.
process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.ShowTextGlyph
TJ Show text, allowing individual glyph positioning.
processCosObject(String) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
processEncodedText(byte[]) - Method in class org.apache.pdfbox.util.PDFStreamEngine
Process encoded text from the PDF Stream.
processNextPage(PDPage) - Method in class org.apache.pdfbox.util.Splitter
Interface to start processing a new page.
processOperator(PDFOperator, List) - Method in class org.apache.pdfbox.pdmodel.font.Type3StreamParser
This is used to handle an operation.
processOperator(String, List<COSBase>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
This is used to handle an operation.
processOperator(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
This is used to handle an operation.
processPage(PDPage, COSStream) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will process the contents of a page.
processPages(List<COSObjectable>) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will process all of the pages and the text that is in them.
processPages(List) - Method in class org.apache.pdfbox.util.Splitter
Interface method to handle the start of the page processing.
processStream(PDPage, PDResources, COSStream) - Method in class org.apache.pdfbox.util.PDFStreamEngine
This will process the contents of the stream.
processSubStream(PDPage, PDResources, COSStream) - Method in class org.apache.pdfbox.util.PDFStreamEngine
Process a sub stream of the current stream.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
You should override this method if you want to perform an action when a text is being processed.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
This will process a TextPosition object and add the text to the list of characters on a page.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFStreamEngine
A method provided as an event interface to allow a subclass to perform some specific functionality when text needs to be processed.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will process a TextPosition object and add the text to the list of characters on a page.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
This will process a TextPosition object and add the text to the list of characters on a page.
PRODUCER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PROP_BUILD - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PROP_PUSHBACK_SIZE - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
system property allowing to define size of push back buffer.
PROPERTIES - Static variable in class org.apache.pdfbox.cos.COSName
The COSName value for "Properties".
protect(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Protects the document with the protection policy pp.
PROTECTION_POLICY_CLASS - Static variable in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Protection policy class for this handler.
ProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
This class represents the protection policy to apply to a document.
ProtectionPolicy() - Constructor for class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
 
PUB_SEC - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
PublicKeyDecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
This class holds necessary information to decrypt a PDF document protected by the public key security handler.
PublicKeyDecryptionMaterial(KeyStore, String, String) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
Create a new public key decryption material.
PublicKeyProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
This class represents the protection policy to use to protect a document with the public key security handler as described in the PDF specification 1.6 p104.
PublicKeyProtectionPolicy() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Constructor for encryption.
PublicKeyRecipient - Class in org.apache.pdfbox.pdmodel.encryption
Represents a recipient in the public key protection policy.
PublicKeyRecipient() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
 
PublicKeySecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
This class implements the public key security handler described in the PDF specification.
PublicKeySecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Constructor.
PublicKeySecurityHandler(PublicKeyProtectionPolicy) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Constructor used for encryption.
PushBackInputStream - Class in org.apache.pdfbox.io
A simple subclass that adds a few convience methods.
PushBackInputStream(InputStream, int) - Constructor for class org.apache.pdfbox.io.PushBackInputStream
Constructor.
put(K, V) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
putAll(Map<? extends K, ? extends V>) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
putMapping(COSName, PDOptionalContentGroup) - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
Puts a mapping from a resource name to an optional content group.
putObjectInPool(COSBase, long, long) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
 

Q

Q - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
QUADDING_CENTERED - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.
QUADDING_LEFT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.
QUADDING_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
A Q value.
QuickSort - Class in org.apache.pdfbox.util
see http://de.wikipedia.org/wiki/Quicksort.
QUOTE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Quote

R

R - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RadialShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for radial shading.
RadialShadingContext(PDShadingType3, ColorModel, AffineTransform, Matrix, int, Rectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
Constructor creates an instance to be used for fill operations.
RadialShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT Paint for radial shading.
RadialShadingPaint(PDShadingType3, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingPaint
Constructor.
RandomAccess - Interface in org.apache.pdfbox.io
An interface to allow PDF files to be stored completely in memory or to use a scratch file on the disk.
RandomAccessBuffer - Class in org.apache.pdfbox.io
An implementation of the RandomAccess interface to store a pdf in memory.
RandomAccessBuffer() - Constructor for class org.apache.pdfbox.io.RandomAccessBuffer
Default constructor.
RandomAccessBufferedFileInputStream - Class in org.apache.pdfbox.io
Provides InputStream access to portions of a file combined with buffered reading of content.
RandomAccessBufferedFileInputStream(File) - Constructor for class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
Create input stream instance for given file.
RandomAccessFile - Class in org.apache.pdfbox.io
An interface to allow temp PDF data to be stored in a scratch file on the disk to reduce memory consumption.
RandomAccessFile(File, String) - Constructor for class org.apache.pdfbox.io.RandomAccessFile
Constructor.
RandomAccessFileInputStream - Class in org.apache.pdfbox.io
This class allows a section of a RandomAccessFile to be accessed as an input stream.
RandomAccessFileInputStream(RandomAccess, long, long) - Constructor for class org.apache.pdfbox.io.RandomAccessFileInputStream
Constructor.
RandomAccessFileOutputStream - Class in org.apache.pdfbox.io
This will write to a RandomAccessFile in the filesystem and keep track of the position it is writing to and the length of the stream.
RandomAccessFileOutputStream(RandomAccess) - Constructor for class org.apache.pdfbox.io.RandomAccessFileOutputStream
Constructor to create an output stream that will write to the end of a random access file.
RandomAccessRead - Interface in org.apache.pdfbox.io
An interface allowing random access read operations.
RANGE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
RB
rc4 - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The RC4 implementation used for cryptographic functions.
read() - Method in class org.apache.pdfbox.io.ASCII85InputStream
This will read the next byte from the stream.
read(byte[], int, int) - Method in class org.apache.pdfbox.io.ASCII85InputStream
This will read a chunk of data.
read() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Read a byte.
read(byte[]) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
read(byte[], int, int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Read a number of bytes.
read() - Method in class org.apache.pdfbox.io.ccitt.CCITTFaxG31DDecodeInputStream
read(byte[], int, int) - Method in class org.apache.pdfbox.io.ccitt.FillOrderChangeInputStream
read() - Method in class org.apache.pdfbox.io.ccitt.FillOrderChangeInputStream
read() - Method in class org.apache.pdfbox.io.PushBackInputStream
read(byte[]) - Method in class org.apache.pdfbox.io.PushBackInputStream
read(byte[], int, int) - Method in class org.apache.pdfbox.io.PushBackInputStream
read() - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Read a single byte of data.
read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Read a buffer of data.
read() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
 
read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
 
read() - Method in class org.apache.pdfbox.io.RandomAccessFile
Read a single byte of data.
read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessFile
Read a buffer of data.
read() - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
read(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
read() - Method in interface org.apache.pdfbox.io.SequentialRead
Read a single byte of data.
read(byte[], int, int) - Method in interface org.apache.pdfbox.io.SequentialRead
Read a buffer of data.
read() - Method in class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
read(byte[]) - Method in class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
read(byte[], int, int) - Method in class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
readBackwardUntilWhitespace() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readByte() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readByteBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readDictionaryBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
ReaderBottomPanel - Class in org.apache.pdfbox.pdfviewer
A panel to display at the bottom of the window for status and other stuff.
ReaderBottomPanel() - Constructor for class org.apache.pdfbox.pdfviewer.ReaderBottomPanel
This is the default constructor.
readExpectedString(String) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read bytes until the end of line marker occurs.
readFully(int) - Method in class org.apache.pdfbox.io.PushBackInputStream
Reads a given number of bytes from the underlying stream.
readGenerationNumber() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read a integer from the Stream and throw an IllegalArgumentException if the integer value has more than the maximum object revision (i.e. : bigger than BaseParser.GENERATION_NUMBER_THRESHOLD)
READING_DIRECTION_L2R - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
READING_DIRECTION_R2L - Static variable in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated.
readInt() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read an integer from the stream.
readInt() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readLine() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read bytes until the first end of line marker occurs.
readLine() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read a line starting with the byte at offset and going forward until it finds a newline.
readLineBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read a line starting with the byte at offset and going backwards until it finds a newline.
readLong() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read an long from the stream.
readLongBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will consume any whitespace, read in bytes until whitespace is found again and then parse the characters which have been read as a long.
readNameBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readNumber() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read in a number and return the COS version of the number (be it a COSInteger or a COSFloat).
readObject(long, long) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read an object from the inputFile at whatever our currentOffset is.
readObject() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This actually reads the object data.
readObjectBackwards() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
readObjectNumber() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read a long from the Stream and throw an IllegalArgumentException if the long value has more than 10 digits (i.e. : bigger than BaseParser.OBJECT_NUMBER_THRESHOLD)
readOperator() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will read an operator from the stream.
readPattern(char[]) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Reads given pattern from BaseParser.pdfSource.
readString() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read the next string from the stream.
readString(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read the next string from the stream up to a certain length.
readString() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
This will read the next string from the stream.
readStringNumber() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This method is used to read a token by the BaseParser.readInt() method and the BaseParser.readLong() method.
readUntilEndStream(OutputStream) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This method will read through the current stream object until we find the keyword "endstream" meaning we're at the end of this object.
readVersionInTrailer(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.PDFParser
The document catalog can also have a /Version parameter which overrides the version specified in the header if, and only if it is greater.
readWord() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
REASON - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
REASONS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RECIPIENTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RECT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
REFERENCE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The reference token.
REFERENCE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Reference
registerHandler(String, Class, Class) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
register a security handler.
registerOperatorProcessor(String, OperatorProcessor) - Method in class org.apache.pdfbox.util.PDFStreamEngine
Register a custom operator processor with the engine.
registerSecurityHandler(String, Class) - Static method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionManager
Deprecated.
This will allow the user to register new security handlers when unencrypting a document.
REGISTRY - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
REGISTRY_NAME - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
releasePdfSourceInputStream() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Enable handling of alternative pdfSource implementation.
remove(int) - Method in class org.apache.pdfbox.cos.COSArray
This will remove an element from the array.
remove(COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will remove an element from the array.
remove(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
remove(int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
remove(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
removeAll(Collection<COSBase>) - Method in class org.apache.pdfbox.cos.COSArray
This will remove all of the objects in the collection.
removeAll(Collection<?>) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
removeAttribute(PDAttributeObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Removes an attribute object.
removeClassName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Removes a class name.
removeItem(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This will remove an item for the dictionary.
removeKid(COSInteger) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Removes a marked-content identifier kid.
removeKid(PDMarkedContentReference) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Removes a marked-content reference kid.
removeKid(PDObjectReference) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Removes an object reference kid.
removeKid(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Removes a structure element kid.
removeKid(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Removes a COS base kid.
removeObject(COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will remove an element from the array.
removeObject(COSObjectKey) - Method in class org.apache.pdfbox.cos.COSDocument
Removes an object from the object pool.
removeObjectableKid(COSObjectable) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Removes an objectable kid.
removePage(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Remove the page from the document.
removePage(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Remove the page from the document.
removeRecipient(PublicKeyRecipient) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Removes a recipient from the recipients list.
removeRegion(String) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
Delete a region to group text by.
removeTreeModelListener(TreeModelListener) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Removes a listener previously added with addTreeModelListener.
removeUserProperty(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Removes a user property.
RENDERING_INTENT_ABSOLUTE_COLORIMETRIC - Static variable in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_PERCEPTUAL - Static variable in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_RELATIVE_COLORIMETRIC - Static variable in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_INTENT_SATURATION - Static variable in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
Rendering intent constants, see PDF Reference 1.5 Section 4.5.4 Rendering Intents.
RENDERING_MODE_ADD_TEXT_TO_PATH_FOR_CLIPPING - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_TEXT - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_THEN_STROKE_TEXT - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_FILL_THEN_STROKE_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_NEITHER_FILL_NOR_STROKE_TEXT - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_STROKE_TEXT - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
RENDERING_MODE_STROKE_TEXT_AND_ADD_TO_PATH_FOR_CLIPPING - Static variable in class org.apache.pdfbox.pdmodel.text.PDTextState
See PDF Reference 1.5 Table 5.3.
REPLACEMENT_CHARACTER - Static variable in class org.apache.pdfbox.encoding.SingleByteCharset
Unicode replacement character 0xFFFD.
replaceWithStream(COSStream) - Method in class org.apache.pdfbox.cos.COSStream
Deprecated.
will be removed
reset() - Method in class org.apache.pdfbox.cos.COSString
This will reset the internal buffer.
reset() - Method in class org.apache.pdfbox.io.ASCII85InputStream
Unsupported.
reset() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Restore the state of this stream to the last saveState call.
reset() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
 
reset() - Method in class org.apache.pdfbox.util.Matrix
This method resets the numbers in this Matrix to the original values, which are the values that a newly constructed Matrix would have.
resetEngine() - Method in class org.apache.pdfbox.util.PDFStreamEngine
This method must be called between processing documents.
resetEngine() - Method in class org.apache.pdfbox.util.PDFTextStripper
This method must be called between processing documents.
ResourceLoader - Class in org.apache.pdfbox.util
This class will handle loading resource files(AFM/CMAP).
resourceRootCMAP - Static variable in class org.apache.pdfbox.pdmodel.font.PDFont
 
RESOURCES - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
restoreGraphicsState() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Q operator.
restrainTZoffset(long) - Static method in class org.apache.pdfbox.util.DateConverter
Constrain a timezone offset to the range [-14:00 thru +14:00].
retainAll(Collection<COSBase>) - Method in class org.apache.pdfbox.cos.COSArray
This will retain all of the objects in the collection.
retainAll(Collection<?>) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
retrieveDestPageNumber() - 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.
REVISION2 - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Encryption revision 2.
REVISION3 - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Encryption revision 3.
REVISION4 - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Encryption revision 4.
Revisions<T> - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
 
Revisions() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
 
RI - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ROLE_CB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
role: cb: Check box
ROLE_MAP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ROLE_PB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
role: pb: Push button
ROLE_RB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
role: rb: Radio button
ROLE_TV - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
role: tv: Text-value field
ROOT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ROTATE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
ROW_SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
ROWS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RP - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
RP
RT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
RT
RT_GROUP - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an annotation reply type.
RT_REPLY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an annotation reply type.
RUBY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Ruby
RUBY_ALIGN_CENTER - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyAlign: Center: The content shall be centered in the inline-progression direction.
RUBY_ALIGN_DISTRIBUTE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyAlign: Distribute: The content shall be expanded to fill the available width in the inline-progression direction.
RUBY_ALIGN_END - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyAlign: End: The content shall be aligned on the end edge in the inline-progression direction.
RUBY_ALIGN_JUSTIFY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyAlign: Justify: The content shall be expanded to fill the available width in the inline-progression direction.
RUBY_ALIGN_START - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyAlign: Start: The content shall be aligned on the start edge in the inline-progression direction.
RUBY_POSITION_AFTER - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyPosition: After: The RT content shall be aligned along the after edge of the element.
RUBY_POSITION_BEFORE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyPosition: Before: The RT content shall be aligned along the before edge of the element.
RUBY_POSITION_INLINE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyPosition: Inline: The RT and associated RP elements shall be formatted as a parenthesis comment, following the RB element.
RUBY_POSITION_WARICHU - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
RubyPosition: Warichu: The RT and associated RP elements shall be formatted as a warichu, following the RB element.
RUN_LENGTH_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RUN_LENGTH_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
RunLengthDecodeFilter - Class in org.apache.pdfbox.filter
This is a filter for the RunLength Decoder.
RunLengthDecodeFilter() - Constructor for class org.apache.pdfbox.filter.RunLengthDecodeFilter
Constructor.
RV - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.

S

S - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
save(File) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
save(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
save(OutputStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save the document to an output stream.
save(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document to a file.
save(File) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document to a file.
save(OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will save the document to an output stream.
saveGraphicsState() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
q operator.
saveIncremental(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the pdf as incremental.
saveIncremental(InputStream, OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the pdf as incremental.
saveXFDF(File) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
saveXFDF(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save this document to the filesystem.
saveXFDF(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will save the document to an output stream and close the stream.
SCALE_OPTION_ALWAYS - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_NEVER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
A scale option.
SCALE_TYPE_ANAMORPHIC - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Scale to fill with of annotation, disregarding aspect ratio.
SCALE_TYPE_PROPORTIONAL - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
Scale to fit width or height, smaller of two, while retaining aspect ration.
SCOPE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
SCOPE_BOTH - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Scope: Both
SCOPE_COLUMN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Scope: Column
SCOPE_ROW - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Scope: Row
SE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SECT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Sect
securityHandler - Variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
The security handler.
SecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
This class represents a security handler as described in the PDF specifications.
SecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
 
SecurityHandlersManager - Class in org.apache.pdfbox.pdmodel.encryption
This class manages security handlers for the application.
seek(int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Position the stream at a given index.
seek(long) - Method in class org.apache.pdfbox.io.PushBackInputStream
Allows to seek to another position within stream in case the underlying stream implements RandomAccessRead.
seek(long) - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Seek to a position in the data.
seek(long) - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
Seeks to new position.
seek(long) - Method in class org.apache.pdfbox.io.RandomAccessFile
Seek to a position in the data.
seek(long) - Method in interface org.apache.pdfbox.io.RandomAccessRead
Seek to a position in the data.
SEPARATION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SequentialRead - Interface in org.apache.pdfbox.io
An interface allowing sequential read operations.
set(int, COSBase) - Method in class org.apache.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int, int) - Method in class org.apache.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int, COSObjectable) - Method in class org.apache.pdfbox.cos.COSArray
This will set an object at a specific index.
set(int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Sets a bit at the given offset.
set(int, E) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
SET_F - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SET_FF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets Acroform
setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the form this field is on.
setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the acro form for this catalog.
setAcroFormDictionary(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Acroform have its Dictionary, so we here set the Dictionary which is in this location: AcroForm/DR
setAcroFormFields(List<PDField>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets acroFormFields
setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the action that is associated with this field.
setAction(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
setAction(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
 
setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set the annotation action.
setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Set the annotation action.
setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the action for this node.
setActions(PDAnnotationAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Set the actions of the field.
setActions(PDFormFieldAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Set the actions of the field.
setActions(PDDocumentCatalogAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the additional actions for the document.
setActions(PDPageAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.PDPage
Set the page actions.
setActualText(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the actual text (ActualText).
setAdditionalActions(PDAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the additional actions that are associated with this field.
setAddMoreFormatting(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
There will some additional text formatting be added if addMoreFormatting is set to true.
setAddRevInfoRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the AddRevInfo shall be required.
setAES(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Set to true if AES for encryption and decryption should be used.
setAffineTransform(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets AffineTransform
setAfter(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This will set the javascript code the will get execute after the import.
setAfterColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Sets the colour for the after edge.
setAllBorderColors(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same border colour for all four sides (BorderColor).
setAllBorderStyles(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same border style for all four sides (BorderStyle).
setAllBorderThicknesses(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same border thickness for all four sides (BorderThickness).
setAllBorderThicknesses(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same border thickness for all four sides (BorderThickness).
setAllCap(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setAllColumnWidths(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same column width for all columns (ColumnWidths).
setAllColumnWidths(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same column width for all columns (ColumnWidths).
setAllPaddings(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same padding for all four sides (Padding).
setAllPaddings(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same padding for all four sides (Padding).
setAllPagesOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the all pages overlay file.
setAllPagesOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the all pages overlay PDF.
setAllSecurityToBeRemoved(boolean) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Activates/Deactivates the removal of all security when writing the pdf.
setAllTBorderStyles(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same table border style for all four sides (TBorderStyle).
setAllTPaddings(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same table padding for all four sides (TPadding).
setAllTPaddings(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the same table padding for all four sides (TPadding).
setAlphaConstants(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the stroke alpha constants property.
setAlphaSource(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the alpha source property.
setAlphaSourceFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the alpha source flag.
setAlternateCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the alternate caption.
setAlternateColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the alternate color space.
setAlternateColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the alternate color space.
setAlternateColorSpaces(List) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the list of alternate color spaces.
setAlternateDescription(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the alternate description (Alt).
setAlternateFieldName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the alternate name of the field.
setAlternateName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Sets the alternate name of the field (Desc).
setAngles(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the angles.
setAnnotationFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the flags for this field.
setAnnotationName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the name, a string intended to uniquely identify each annotation within a page.
setAnnotations(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of annotations.
setAnnotations(List<PDAnnotation>) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the list of annotations.
setAntiAlias(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the AntiAlias value.
setAppearance(PDAppearanceDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the appearance associated with this annotation.
setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Sets the appearance characteristics dictionary.
setAppearanceDictionary(PDAppearanceDictionary) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the appearance dictionary.
setAppearanceDictionary(PDAppearanceDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets AppearanceDictionary That is /AP entry the appearance dictionary.
setAppearanceStream(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the annotations appearance stream name.
setAppearanceStreamReference(FDFNamedPageReference) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the named page references.
setAppearanceValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAppearance
This is the public method for setting the appearance stream.
setARange(PDRange) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will set the a range for the "a" component.
setAreas(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the areas.
setArrayOfName(String, String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets an array of name values.
setArrayOfNumber(String, float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets an array of float numbers.
setArrayOfString(String, String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets an array of strings.
setArtBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the ArtBox for this page.
setArticleEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the end of an article.
setArticleStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the beginning of an article.
setArticleStart() - Method in class org.apache.pdfbox.util.PositionWrapper
Sets the isArticleStart() flag to true.
setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the ascent for the font.
setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the ascent for the font.
setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the ascent for the font.
setAttachementName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set the name used to draw the attachement icon.
setAttribute(String, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
Sets an attribute.
setAttributes(Revisions<PDAttributeObject>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the attributes together with their revision numbers (A).
setAttributes(PDDeviceNAttributes) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the color space attributes.
setAuthor(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the author of the document.
setAutomaticStrokeAdjustment(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the automatic stroke adjustment flag.
setAverageCharTolerance(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the character width-based tolerance value that is used to estimate where spaces in text should be added.
setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the average width for the font.
setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the average width for the font.
setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the average width for the font.
setB(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will set the b value of the tristimulus.
setBackground(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the background.
setBackground(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the background color.
setBackgroundColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the background colour (BackgroundColor).
setBase(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
Deprecated.
setBase(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
This will set the base URI to be used in resolving relative URI references.
setBaseColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will set the base color space.
setBaseFont(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Set the PostScript name of the font.
setBaselineShift(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance by which the element's baseline shall be shifted relative to that of its parent element (BaselineShift).
setBaselineShift(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance by which the element's baseline shall be shifted relative to that of its parent element (BaselineShift).
setBaseState(PDOptionalContentProperties.BaseState) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Sets the base state for optional content groups.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the bounding box.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the BBox (bounding box) for this Pattern.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the BBox (bounding box) for this Shading.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will set the BBox (bounding box) for this form.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will set the rectangle specifying the location of the viewport.
setBefore(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This will set the javascript code the will get execute before the import.
setBeforeColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Sets the colour for the before edge.
setBits(int, int, int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Sets a run of bits at the given offset to either 1 or 0.
setBits(int, int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Sets a run of bits at the given offset to either 1.
setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the number of bits per component.
setBitsPerComponent(int) - Method in class org.apache.pdfbox.util.ImageParameters
Set the number of bits per component.
setBitsPerFlag(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
Set the number of bits per flag.
setBitsPerSample(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Set the number of bits that the output value will take up.
setBl(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the annotation loses the input focus.
setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will set the BlackPoint tristimulus.
setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the BlackPoint tristimulus.
setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will set the BlackPoint tristimulus.
setBleedBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the BleedBox for this page.
setBlockAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the alignment, in the block-progression direction, of content within the table cell (BlockAlign).
setBold(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the bold property of the text.
setBoolean(String, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setBoolean(COSName, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setBorderColors(PDFourColours) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the border colours for four sides separately (BorderColor).
setBorderColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the border color.
setBorderEffect(PDBorderEffectDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the border effect dictionary, specifying effects to be applied when drawing the line.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
setBorderStyles(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the border styles for four sides separately (BorderStyle).
setBorderThicknesses(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the border thicknesses for four sides separately (BorderThickness).
setBottom(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will set the bounding box for this appearance stream.
setBpp(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
setBpp(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setBRange(PDRange) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will set the "b" range for this color space.
setByteRange(int[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the byte range.
setC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed in order to recalculate the value of this field when that of another field changes.
setC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will set an action to be performed when the page is closed.
setCacheFields(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell this form to cache the fields into a Map structure for fast access via the getField method.
setCanAssembleDocument(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can insert/rotate/delete pages.
setCanAssembleDocument(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can insert/rotate/delete pages.
setCanExtractContent(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can extract content from the document.
setCanExtractContent(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can extract content from the document.
setCanExtractForAccessibility(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can extract content from the document for accessibility purposes.
setCanExtractForAccessibility(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can extract content from the document for accessibility purposes.
setCanFillInForm(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can fill in interactive form fields (including signature fields) even if canModifyAnnotations() returns false.
setCanFillInForm(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can fill in interactive forms.
setCanModify(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can modify the document.
setCanModify(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can modify the document.
setCanModifyAnnotations(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can add or modify text annotations and fill in interactive forms fields and, if canModify() returns true, create or modify interactive form fields (including signature fields).
setCanModifyAnnotations(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can modify annotations.
setCanPrint(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print.
setCanPrint(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can print.
setCanPrintDegraded(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print the document in a degraded format.
setCanPrintDegraded(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
Set if the user can print the document in a degraded format.
setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the cap height for the font.
setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the cap height for the font.
setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the cap height for the font.
setCaption(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set if the contents are shown as a caption to the line.
setCaptionHorizontalOffset(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the horizontal offset of the caption.
setCaptionPositioning(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the caption positioning.
setCaptionVerticalOffset(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the vertical offset of the caption.
setCatalog(FDFCatalog) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will set the FDF catalog for this FDF document.
setCenterWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the center window preference.
setChangeXs(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the changes along the x-axis.
setChangeYs(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the changes along the y-axis.
setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the character set for the font.
setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the character set for the font.
setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the character set for the font.
setCharacterSpacing(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the characterSpacing.
SetCharSpacing - Class in org.apache.pdfbox.util.operator
 
SetCharSpacing() - Constructor for class org.apache.pdfbox.util.operator.SetCharSpacing
 
setCheckedState(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Sets the checked state.
setCheckSum(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the check sum.
setClassNames(Revisions<String>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the class names together with their revision numbers (C).
setClearFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClearWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setClippingPath(int) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
setClippingWindingRule(int) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Set the clipping winding rule.
setColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the color to be used for drawing text and the default value for the colour of table borders and text decorations (Color).
setColor(String, PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets a colour.
setColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the annotation color.
setColorantName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the separation name.
setColorantNames(List<String>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the list of colorants.
setColorants(Map) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
This will replace the existing colorant attribute.
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will set the current colorspace.
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the color space for the shading.
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
This will set the color space for this image.
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.util.ImageParameters
This will set the color space for this image.
setColorSpaces(Map<String, PDColorSpace>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of colorspaces.
setColorSpaces(Map<String, PDColorSpace>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
setColorSpaceValue(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will update the colorspace values.
setColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the colour used in drawing various elements.
setColSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
setColSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Sets the number of columns in the enclosing table that shall be spanned by the cell (ColSpan).
setColumnCount(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the number of columns in the content of the grouping element (ColumnCount).
setColumnGap(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the desired space between all columns in the inline-progression direction (ColumnGap).
setColumnGap(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the desired space between all columns in the inline-progression direction (ColumnGap).
setColumnGaps(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the desired space between adjacent columns in the inline-progression direction (ColumnGap), the first element specifying the space between the first and second columns, the second specifying the space between the second and third columns, and so on.
setColumnWidths(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the column widths for the columns separately (ColumnWidths).
setComb(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the comb bit.
setConstantOpacity(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the constant opacity value used when rendering the annotation (excluing any popup).
setContactInfo(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the contact info.
setContents(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the "contents" of the field.
setContents(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the contents.
setContents(PDStream) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the contents of this page.
setContext(PDFStreamEngine) - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
Set the processing context.
setConversionFactor(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the conversion factor.
setCoords(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
Sets the Coords entry for this shading.
setCoordSystemOrigin(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the origin of the coordinate system.
setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the creation date.
setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the creation date.
setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the the date and time the annotation was created.
setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the creation date of the document.
setCreator(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the creator of the document.
setCropBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the CropBox for this page.
setCropBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will set the CropBox for this page.
setCryptFilterMethod(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will set the crypt filter method.
setCurrentClippingPath(Shape) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the current clipping path.
setCurrentTransformationMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Set the value of the CTM.
setCustomMetadataValue(String, String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
Set the custom metadata value.
setCYX(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the CYX factor.
setD(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the mouse button is pressed inside the annotation's active area.
setD(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the string specifying the default directory in standard DOS syntax.
setD(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the destination to jump to.
setDashPattern(List) - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
This will replace the existing line dash pattern.
setDashStyle(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the dash style used for drawing the border.
setDate(String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
Set the value of a date entry in the dictionary.
setDate(COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
Set the date object.
setDate(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
The annotation modification date.
setDate(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The build date of the software module.
setDecimalSeparator(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the text to be used as the decimal point in displaying numerical values.
setDecodedStreamLength(int) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Set the decoded stream length.
setDecodeParams(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will set the list of decode params.
setDecodeParms(List<?>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the list of decode parameterss.
setDecodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
This will set the decode values.
setDecrypted() - Method in class org.apache.pdfbox.cos.COSDocument
Signals that the document is decrypted completely.
setDecryptionCertificate(X509Certificate) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Setter of the property decryptionCertificate.
setDefaultAppearanceString(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will set the default appearance string.
setDefaultOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the default overlay file.
setDefaultOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the default overlay PDF.
setDefaultResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will set the default resources for the acroform.
setDefaultWidth(long) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
This will set the default width for the glyphs of this font.
setDenominator(int) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the precision or denominator of a fractional amount.
setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the descent for the font.
setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the descent for the font.
setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the descent for the font.
setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This will set the destination to jump to.
setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
The new destination value.
setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the page destination for this node.
setDestination(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
A convenience method that will create an XYZ destination using only the defaults.
setDestinationFileName(String) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Set the name of the destination file.
setDestinationStream(OutputStream) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Set the destination OutputStream.
setDests(PDDestinationNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Set the named destinations that are associated with this document.
setDifferences(COSStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the differences stream.
setDigestMethod(List<COSName>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional, PDF 1.7) An array of names indicating acceptable digest algorithms to use when signing.
setDigestMethodRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the DigestMethod shall be required.
setDirect(boolean) - Method in class org.apache.pdfbox.cos.COSBase
Set the state true, if the dictionary should be written as a direct object and not indirect.
setDirectory(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the dir to launch from.
setDisplayDocTitle(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the display doc title preference.
setDistances(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the distances.
setDocument(COSDocument) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Set the document for this stream.
setDocument(PDDocument) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Set the document to display in the tree.
setDocumentID(COSArray) - Method in class org.apache.pdfbox.cos.COSDocument
This will set the document ID.
setDocumentId(Long) - Method in class org.apache.pdfbox.pdmodel.PDDocument
 
setDocumentInformation(PDDocumentInformation) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will set the document information for this document.
setDocumentOutline(PDDocumentOutline) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the document outlines.
setDomain(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
Sets the optional Domain entry for the function based shading.
setDomain(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
Sets the optional Domain entry for this shading.
setDomainValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
This will set the domain values.
setDoNotScroll(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the doNotScroll bit.
setDoNotSpellCheck(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the doNotSpellCheck bit.
setDownAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setDownAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set the down appearance when there is down appearance to be shown.
setDP(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed after printing a document.
setDropThreshold(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
sets the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start.
setDS(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed after saving a document.
setDuplex(PDViewerPreferences.DUPLEX) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the Duplex preference.
setE(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the cursor enters the annotation's active area.
setElementIdentifier(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the element identifier (ID).
setEmbeddedDate(String, String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
Set the value of a date entry in the dictionary.
setEmbeddedDate(String, COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
Set the date object.
setEmbeddedFDFs(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of embedded FDFs.
setEmbeddedFile(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded file for this spec.
setEmbeddedFileDos(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded dos file for this spec.
setEmbeddedFileMac(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded Mac file for this spec.
setEmbeddedFiles(PDEmbeddedFilesNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Set the named embedded files that are associated with this document.
setEmbeddedFileUnicode(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded Unicode file for this spec.
setEmbeddedFileUnix(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the embedded Unix file for this spec.
setEmbeddedInt(String, String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setEmbeddedInt(String, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setEmbeddedString(String, String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setEmbeddedString(String, COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setEncodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
This will set the encode values.
setEncoding(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the encoding.
setEncoding(COSBase) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Set the encoding object from the fonts dictionary.
setEncryptionDictionary(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDocument
This will set the encryption dictionary, this should only be called when encrypting the document.
setEncryptionDictionary(PDEncryptionDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will set the encryption dictionary for this document.
setEncryptionKeyLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
set the length in (bits) of the secret key that will be used to encrypt document data.
setEndBookmark(PDOutlineItem) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the bookmark where the text extraction should stop.
setEndColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Sets the colour for the end edge.
setEndIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
setEndIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance from the end edge of the BLSE to that of the reference area in the inline-progression direction (EndIndent).
setEndPage(int) - Method in class org.apache.pdfbox.util.PageExtractor
Sets the last page number to be extracted.
setEndPage(int) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will set the last page to be extracted by this class.
setEndPage(int) - Method in class org.apache.pdfbox.util.Splitter
This will set the end page.
setEndPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the line ending style for the end point, see the LE_ constants for the possible values.
setEOFLookupRange(int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Sets how many trailing bytes of PDF file are searched for EOF marker and 'startxref' marker.
setEvenPageOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the even page overlay file.
setEvenPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the even page overlay PDF.
setExecuteParam(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the parameter to pass the executable.
setExpandedForm(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the expanded form (E).
setExpectedLength(COSBase) - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
This will set the expected length of this stream.
setExtend(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
Sets the optional Extend entry for this shading.
setExtendedGraphicsState(PDExtendedGraphicsState) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will set the extended graphics state for this pattern.
setExtends(PDObjectStream) - 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.
setExternalData(PDExternalDataDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the external data dictionary.
setF(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
Set the F action.
setF(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed before the field is formatted to display its current value.
setF(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the file name to be launched or the document to be opened or printed, in standard Windows pathname format.
setFD(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the value indication if the denominator of the fractional value is reduced/truncated .
setFDF(FDFDictionary) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will set the FDF document.
setFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the flags for this field.
setFields(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of fields.
setFields(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will set a list of fields for this template.
setFields(List) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the documents root fields.
setFieldType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Set the field type.
setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set the file name.
setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
This will set the file name.
setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
This will set the file name.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Set the file specification.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Set the file specification.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the file specification.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the application to be launched or the document to be opened or printed.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set the attached file.
setFileDecodeParams(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will set the list of decode params.
setFileDecodeParams(List<?>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the list of decode params.
setFileDescription(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Set the file description.
setFileDos(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a dos file.
setFileFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will set the filters that are part of this stream.
setFileFilters(List<String>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the filters that are part of this stream.
setFileMac(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a Mac file.
setFilename(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the file to launch.
setFileSelect(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the file select bit.
setFileSpecification(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will set the file specification for this named page reference.
setFileUnicode(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set unicode file name.
setFileUnix(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will set name representing a Unix file.
setFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Sets the filter entry of the encryption dictionary.
setFilter(String) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
Sets the filter entry of the encryption dictionary.
setFilter(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) The signature handler that shall be used to sign the signature field.
setFilter(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Set the filter.
setFilteredLength(long) - Method in class org.apache.pdfbox.cos.COSStream
This will set the expected length of the encoded stream.
setFilterRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the filter shall be required.
setFilters(COSBase) - Method in class org.apache.pdfbox.cos.COSStream
set the filters to be applied to the stream.
setFilters(COSBase) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
set the filters to be applied to the stream.
setFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
This will set the filters that are part of this stream.
setFilters(List<COSName>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the filters that are part of this stream.
setFilters(List) - Method in class org.apache.pdfbox.util.ImageParameters
This will set the filters that are part of this stream.
setFirstBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
This will set the first bead in the thread.
setFirstByteOffset(int) - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
The byte offset (in the decoded stream) of the first compressed object.
setFirstChar(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Set the first character this font supports.
setFirstChild(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the first child, this will be maintained by this class.
setFirstPageOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the first page overlay file.
setFirstPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the first page overlay PDF.
setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
Set if this page destination should just fit the bounding box.
setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Set if this page destination should just fit the bounding box.
setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Set if this page destination should just fit the bounding box.
setFitWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the fit window preference.
setFixedPitch(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setFlag(COSDictionary, String, int, boolean) - Static method in class org.apache.pdfbox.util.BitFlagHelper
Deprecated.
setFlag(COSDictionary, COSName, int, boolean) - Static method in class org.apache.pdfbox.util.BitFlagHelper
Sets the given boolean value at bitPos in the flags.
setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font flags.
setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font flags.
setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font flags.
setFlatness(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the flatness property.
setFlatnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the flatness tolerance.
setFloat(String, float) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSFloat object.
setFloat(COSName, float) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSFloat object.
setFloatArray(float[]) - Method in class org.apache.pdfbox.cos.COSArray
Clear the current contents of the COSArray and set it with the float[].
setFo(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the annotation receives the input focus.
setFont(PDFont, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the font to draw text with.
setFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
This will set the font for this font setting.
setFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the font.
setFont(PDSimpleFont) - Method in class org.apache.pdfbox.TextToPDF
 
setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set the fonts bounding box.
setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
Set the fonts bounding box.
setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the fonts bounding box.
setFontDescriptor(PDFontDescriptorDictionary) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will set the font descriptor.
setFontEncoding(Encoding) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
The will set the encoding for this font.
setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font family.
setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font family.
setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font family.
setFontFile(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the type 1 font program.
setFontFile2(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the true type font program.
setFontFile3(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set a stream containing a font program that is not true type or type 1.
setFontMatrix(PDMatrix) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
Set the font matrix for this type3 font.
setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font name.
setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font name.
setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font name.
setFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of fonts.
setFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
setFontSetting(PDFontSetting) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the font setting for this graphics state.
setFontSize(float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
This will set the size of the font.
setFontSize(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the fontSize.
setFontSize(int) - Method in class org.apache.pdfbox.TextToPDF
 
setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font stretch.
setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the font stretch.
setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the font stretch.
setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set the weight of the font.
setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
Set the weight of the font.
setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
Set the weight of the font.
setForceBold(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setForceHexForm(boolean) - Method in class org.apache.pdfbox.cos.COSString
Forces the string to be written in hexadecimal form instead of literal form.
setForceLiteralForm(boolean) - Method in class org.apache.pdfbox.cos.COSString
Forces the string to be written in literal form instead of hexadecimal form.
setForceParsing(boolean) - Method in class org.apache.pdfbox.util.PDFStreamEngine
Enable/Disable force parsing.
setFormaterRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets formatter rectangle
setFormattedValue(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Sets the string for the property value.
setFormType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Set the form type.
setFourColors(String, PDFourColours) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets four colours.
setFractionalDisplay(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the value for the manner to display a fractional value.
setFractionalSpaceToAllocate(PDRange) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will set frational space to allocate.
setFree(boolean) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
This will set the free attribute.
setFromAffineTransform(AffineTransform) - Method in class org.apache.pdfbox.util.Matrix
Set the values of the matrix from the AffineTransform.
setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the function for the color conversion.
setFunction(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the functions COSArray for the color conversion.
setG(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will set the g value of the tristimulus.
setGamma(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Set the gamma value.
setGamma(PDGamma) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Set the gamma value.
setGeneration(long) - Method in class org.apache.pdfbox.cos.COSUnread
 
setGeneration(long) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
This will set the objects generation number.
setGenerationNumber(COSInteger) - Method in class org.apache.pdfbox.cos.COSObject
Setter for property generationNumber.
setGlyphOrientationVertical(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top (GlyphOrientationVertical).
setGraphicsStack(Stack<PDGraphicsState>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
setGraphicsState(PDGraphicsState) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
SetGraphicsStateParameters - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetGraphicsStateParameters() - Constructor for class org.apache.pdfbox.util.operator.SetGraphicsStateParameters
 
setGraphicsStates(Map<String, PDExtendedGraphicsState>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of graphics states.
setGraphicsStates(Map<String, PDExtendedGraphicsState>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
setGroupEnabled(String, boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Enables or disables an optional content group.
setGuideLineColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the color space instance for this box style.
setGuidelineStyle(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the style for the box.
setGuidelineWidth(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the guideline width.
setHangingIndent() - Method in class org.apache.pdfbox.util.PositionWrapper
Sets the isHangingIndent() flag to true.
setHasToUnicode(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Sets hasToUnicode to the given value.
setHeaders(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the headers (Headers).
setHeaders(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Sets the headers (Headers).
setHeaderString(String) - Method in class org.apache.pdfbox.cos.COSDocument
 
setHeight(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the height of the element's content rectangle in the block-progression direction (Height).
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the height of the element's content rectangle in the block-progression direction (Height).
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the height of the image.
setHeight(int) - Method in class org.apache.pdfbox.util.ImageParameters
Set the height of the image.
setHeightAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the height of the element's content rectangle in the block-progression direction (Height) to PDLayoutAttributeObject.HEIGHT_AUTO.
setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Specifies whether the property shall be hidden.
setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the hidden flag.
setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the hidden flag.
setHideMenubar(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the menubar preference.
setHideToolbar(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the toolbar preference.
setHideWindowUI(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the window UI preference.
setHighlightingMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Sets the highlighting mode.
setHighlightMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set the highlight mode.
setHighValue(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will set the highest value that is allowed.
setHolderForm(PDXObjectForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
In the structure, form will be contained by XObject in the AcroForm/DR/
setHolderFormResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets holder form resources
setHolderFormStream(PDStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets stream of holder form Stream
setHorizontalScalingPercent(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the horizontalScaling.
SetHorizontalTextScaling - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetHorizontalTextScaling() - Constructor for class org.apache.pdfbox.util.operator.SetHorizontalTextScaling
 
setIccOverrideColor(Color) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
Sets the default color to replace all colors in ICC color spaces.
setIconFit(FDFIconFit) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the icon fit entry.
setID(COSArray) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the FDF id.
setIDTree(PDNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the ID tree.
setIgnoreAcroFormErrors(boolean) - Method in class org.apache.pdfbox.util.PDFMergerUtility
Set to true to ignore acroform errors.
setImageData(byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
Set the bytes that make up the image.
setImageData(byte[]) - Method in class org.apache.pdfbox.util.PDFOperator
This will set the image data, this is only used for the ID operator.
setImageForm(PDXObjectForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets Image form.
setImageFormName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets image form name
setImageFormResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets image form resource
setImageFormStream(PDStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets image form stream
setImageName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets visible signature image name
setImageParameters(ImageParameters) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
This will set the image parameters for this image.
setImageParameters(ImageParameters) - Method in class org.apache.pdfbox.util.PDFOperator
This will set the image parameters, this is only valid for BI operators.
setIndentThreshold(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
sets the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.
setIndex(int) - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
This will set the index value.
setInfo(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
setInlineAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the alignment, in the inline-progression direction, of content within the table cell (InlineAlign).
setInnerForm(PDXObjectForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
sets inner form to this location: AcroForm/DR/XObject/{holder form name}/Resources/XObject/{destination}
setInnerFormName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets inner form name
setInnerFormResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets inner form resource
setInnterFormStream(PDStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets inner form stream
setInputFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the file to be overlayed.
setInputPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the PDF to be overlayed.
setInReplyTo(PDAnnotation) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
setInt(int, int) - Method in class org.apache.pdfbox.cos.COSArray
Set the value in the array as an integer.
setInt(String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setInt(COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setInteger(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets an integer.
setIntensity(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will set the intensity of the applied effect.
setIntent(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
setInteriorColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set interior colour of the line endings defined in the LE entry.
setInteriorColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set interior colour of the drawn area Colour is in DeviceRGB colourspace.
setInvisible(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the invisible flag.
setInvisible(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the invisible flag.
setIsFontSubstituted(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will set the value for isFontSubstituted.
setItalic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setItalic(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the italic property of the text.
setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the italic angle for the font.
setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the italic angle for the font.
setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the italic angle for the font.
setItem(COSName, COSBase) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(COSName, COSObjectable) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(String, COSObjectable) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setItem(String, COSBase) - Method in class org.apache.pdfbox.cos.COSDictionary
This will set an item in the dictionary.
setJavaScript(FDFJavaScript) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the JavaScript entry.
setJavascript(PDJavascriptNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
Set the named javascript entries that are associated with this document.
setJpedImage(PDJpeg) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets the image of visible signature
setK(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the K entry.
setK(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box.
setKey(byte[]) - Method in class org.apache.pdfbox.encryption.ARCFour
This will reset the key to be used.
setKey(Object) - Method in class org.apache.pdfbox.pdfviewer.MapEntry
This will set the key for this entry.
setKeyLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Setter of the property keyLength.
setKeywords(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the keywords of the document.
setKids(List<? extends PDNameTreeNode>) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Set the children of this named tree.
setKids(List<? extends PDNumberTreeNode>) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Set the children of this number tree.
setKids(List<Object>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Sets the kids (K).
setKids(List<FDFField>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the list of kids.
setKids(List<COSObjectable>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the list of kids.
setKnockoutFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the knockout.
setLabelItem(int, PDPageLabelRange) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Sets the page label range beginning at the specified start page.
setLabelPositionToValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the value indicating the ordering of the label specified by U to the calculated unit value.
setLabelPrefixString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the text to be concatenated to the left of the label specified by U.
setLabelSuffixString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the text to be concatenated after the label specified by U.
setLandscape(boolean) - Method in class org.apache.pdfbox.TextToPDF
Sets paper orientation.
setLanguage(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the language (Lang).
setLanguage(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the Language for the document.
setLastChar(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Set the last character this font supports.
setLastChild(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the last child, this will be maintained by this class.
setLastPageOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the last page overlay file.
setLastPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the last page overlay PDF.
setLeaderLineExtensionLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the length of the leader line extensions.
setLeaderLineLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the length of the leader line.
setLeaderLineOffsetLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the length of the leader line offset.
setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the leading for the font.
setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the leading for the font.
setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the leading for the font.
setLeading(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the leading.
setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the left x-coordinate, values 0 or -1 imply that the current x-coordinate will be used.
setLegalAttestation(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional, PDF 1.6) An array of text strings that specifying possible legal attestations.
setLegalAttestationRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the LegalAttestation shall be required.
setLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will set the number of bits to use for the crypt filter algorithm.
setLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the number of bits to use for the encryption algorithm.
setLength(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will set the length of the content stream.
setLength(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the length of the content stream.
setLenient(boolean) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Change the parser leniency flag.
setLine(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set start and end coordinates of the line (or leader line if LL entry is set).
setLinearInterpretation(PDMatrix) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the linear interpretation matrix.
setLineCap(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the line cap.
setLineCapStyle(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the line cap style.
setLineCapStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line cap style for the graphics state.
SetLineCapStyle - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
SetLineCapStyle() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineCapStyle
 
SetLineCapStyle - Class in org.apache.pdfbox.util.operator
Implementation of content stream operator for page drawer.
SetLineCapStyle() - Constructor for class org.apache.pdfbox.util.operator.SetLineCapStyle
 
setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the line dash pattern associated with this box style.
setLineDashPattern(float[], float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the line dash pattern.
setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the dash pattern for the graphics state.
setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the current line dash pattern.
SetLineDashPattern - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
SetLineDashPattern() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineDashPattern
 
SetLineDashPattern - Class in org.apache.pdfbox.util.operator
Implementation of content stream operator for page drawer.
SetLineDashPattern() - Constructor for class org.apache.pdfbox.util.operator.SetLineDashPattern
 
setLineHeight(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the element's preferred height in the block-progression direction (LineHeight).
setLineHeight(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the element's preferred height in the block-progression direction (LineHeight).
setLineHeightAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the element's preferred height in the block-progression direction (LineHeight) to PDLayoutAttributeObject.LINE_HEIGHT_AUTO.
setLineHeightNormal() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the element's preferred height in the block-progression direction (LineHeight) to PDLayoutAttributeObject.LINE_HEIGHT_NORMAL.
setLineJoin(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
Get the value of the line join.
setLineJoinStyle(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the line join style.
setLineJoinStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line join style.
SetLineJoinStyle - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
SetLineJoinStyle() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineJoinStyle
 
SetLineJoinStyle - Class in org.apache.pdfbox.util.operator
Implementation of content stream operator for page drawer.
SetLineJoinStyle() - Constructor for class org.apache.pdfbox.util.operator.SetLineJoinStyle
 
setLineLength(int) - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will set the line length that will be used.
SetLineMiterLimit - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
SetLineMiterLimit() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineMiterLimit
 
SetLineMiterLimit - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetLineMiterLimit() - Constructor for class org.apache.pdfbox.util.operator.SetLineMiterLimit
 
setLinePath(GeneralPath) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Set the line path to draw.
setLineSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the desired line separator for output text.
setLineSloaps(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the sloaps of a line.
setLineStart() - Method in class org.apache.pdfbox.util.PositionWrapper
Sets the isLineStart() flag to true.
setLineWidth(float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set linewidth to the given value.
setLineWidth(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the line width.
setLineWidth(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the line width.
SetLineWidth - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
SetLineWidth() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineWidth
 
SetLineWidth - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetLineWidth() - Constructor for class org.apache.pdfbox.util.operator.SetLineWidth
 
setListItemPatterns(List<Pattern>) - Method in class org.apache.pdfbox.util.PDFTextStripper
use to supply a different set of regular expression patterns for matching list item starts.
setListNumbering(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the list numbering (ListNumbering).
setListNumbering(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
Sets the list numbering (ListNumbering).
setLocation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the location.
setLocked(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the locked flag.
setLocked(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the locked flag.
setLong(String, long) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setLong(COSName, long) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSInteger object.
setLookupColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
This will set a color in the color lookup table.
setLowerLeftX(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will set the lower left x coordinate.
setLowerLeftY(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will set the lower left y coordinate.
setMacCreator(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac Creator.
setMacResFork(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac ResFork.
setMacSubtype(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mac subtype.
setMarked(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set if this is a tagged PDF.
setMarkInfo(PDMarkInfo) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set information about the doc's usage of tagged features.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
Sets the optional Matrix entry for the Pattern.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
Sets the optional Matrix entry for the Pattern.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
Sets the optional Matrix entry for the function based shading.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
Sets the optional Matrix entry for the form XObject.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Sets the optional Matrix entry for this appearance.
SetMatrix - Class in org.apache.pdfbox.util.operator
 
SetMatrix() - Constructor for class org.apache.pdfbox.util.operator.SetMatrix
 
setMax(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will set the maximum value for the range.
setMaxLen(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
Sets the maximum number of characters of the text field.
setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the max width for the font.
setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the max width for the font.
setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the max width for the font.
setMCID(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Sets the marked content identifier.
setMeasure(PDMeasureDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will set the measure dictionary.
setMediaBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the mediaBox for this page.
setMediaBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will set the mediaBox for this page.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Set the metadata for this object.
setMetadata(COSStream) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the metadata stream that is associated with this color space.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the metadata for this object.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.PDPage
Set the metadata for this object.
setMin(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRange
This will set the minimum value for the range.
setMinimumRevision(long) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The software module revision number, used to determinate the minimum version of software that is required in order to process this signature.
setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the missing width for the font.
setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the missing width for the font.
setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the missing width for the font.
setMiterLimit(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the miter limit for the graphics state.
setMiterLimit(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the miter limit.
setModDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the mod date.
setModificationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the modification date of the document.
setModifiedDate(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the date and time the annotation was modified.
setModifiedDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the date and time the annotation was modified.
SetMoveAndShow - Class in org.apache.pdfbox.util.operator
 
SetMoveAndShow() - Constructor for class org.apache.pdfbox.util.operator.SetMoveAndShow
 
setMPD(PDSeedValueMDP) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional; PDF 1.6) A dictionary containing a single entry whose key is P and whose value is an integer between 0 and 3.
setMultiline(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the multiline bit.
setN(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
This will set the name of the action to be performed.
setName(int, String) - Method in class org.apache.pdfbox.cos.COSArray
Set the value in the array as a name.
setName(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSName object.
setName(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSName object.
setName(String) - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
This will set the name of the named text stream.
setName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Sets the property name.
setName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets a name value.
setName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set a unique name for an annotation.
setName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
This will set the name of the referenced page.
setName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
Sets the name of the optional content group.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
This will set the name (and hence appearance, AP taking precedence) For this annotation.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set the name (and hence appearance, AP taking precedence) For this annotation.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The name of the software module that was used to create the signature.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the name.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will set the name of the viewport.
setNamedDestination(String) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Set the named destination.
setNamedJavaScripts(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
This should be a list of PDNamedTextStream objects.
setNames(Map<String, ? extends COSObjectable>) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Set the names of for this node.
setNames(PDDocumentNameDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the names dictionary for the document.
setNeedToBeUpdate(boolean) - Method in class org.apache.pdfbox.cos.COSBase
 
setNext(List) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the next action, or sequence of actions, to be performed after this one.
setNextBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the next bead in the thread.
setNextSibling(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the next sibling, this will be maintained by this class.
setNoExport(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
sets the field to be not exported..
setNonFullScreenPageMode(PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the non full screen page mode preference.
setNonFullScreenPageMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setNonStrokeAlphaConstants(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the non-stroke alpha constants property.
setNonStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the non stroking alpha constant.
SetNonStrokingCalRGBColor - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingCalRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingCalRGBColor
 
SetNonStrokingCMYKColor - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingCMYKColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingCMYKColor
 
setNonStrokingColor(Color) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as RGB.
setNonStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the color components of current non stroking colorspace.
setNonStrokingColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as RGB, 0-255.
setNonStrokingColor(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as CMYK, 0-255.
setNonStrokingColor(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as CMYK, 0.0-1.0.
setNonStrokingColor(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as grayscale, 0-255.
setNonStrokingColor(double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the non stroking color, specified as Grayscale 0.0-1.0.
SetNonStrokingColor - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingColor
 
setNonStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color space.
SetNonStrokingColorSpace - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingColorSpace() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingColorSpace
 
SetNonStrokingDeviceN - Class in org.apache.pdfbox.util.operator
 
SetNonStrokingDeviceN() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingDeviceN
 
SetNonStrokingGrayColor - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingGrayColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingGrayColor
 
SetNonStrokingICCBasedColor - Class in org.apache.pdfbox.util.operator
 
SetNonStrokingICCBasedColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingICCBasedColor
 
SetNonStrokingIndexed - Class in org.apache.pdfbox.util.operator
 
SetNonStrokingIndexed() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingIndexed
 
SetNonStrokingLabColor - Class in org.apache.pdfbox.util.operator
Sets the non stroking color values for Lab colorspace.
SetNonStrokingLabColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingLabColor
 
setNonStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control(OP).
SetNonStrokingPattern - Class in org.apache.pdfbox.util.operator
Set the non stroking pattern.
SetNonStrokingPattern() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingPattern
 
SetNonStrokingRGBColor - Class in org.apache.pdfbox.util.operator
Set the non stroking color space.
SetNonStrokingRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingRGBColor
 
SetNonStrokingSeparation - Class in org.apache.pdfbox.util.operator
 
SetNonStrokingSeparation() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingSeparation
 
setNonSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setNormalAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setNormalAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set the normal appearance when there is only one appearance to be shown.
setNormalCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the normal caption.
setNoRotate(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the noRotate flag.
setNoRotate(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noRotate flag.
setNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the noView flag.
setNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noView flag.
setNoZoom(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the noZoom flag.
setNoZoom(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the noZoom flag.
setNumber(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will set the current object number.
setNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets a float number.
setNumber(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets an integer number.
setNumber(long) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
This will set the objects id.
setNumberOfComponents(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the number of color components.
setNumberOfObjects(int) - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
Set the number of objects.
setNumbers(Map<Integer, ? extends COSObjectable>) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
Set the names of for this node.
setO(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will set an action to be performed when the page is opened.
setO(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set the string specifying the operation to perform: open to open a document print to print a document If the F entry designates an application instead of a document, this entry is ignored and the application is launched.
setObject(COSBase) - Method in class org.apache.pdfbox.cos.COSObject
This will set the object that this object encapsulates.
setObjectNumber(COSInteger) - Method in class org.apache.pdfbox.cos.COSObject
Setter for property objectNumber.
setObjectNumber(long) - Method in class org.apache.pdfbox.cos.COSUnread
 
setOCProperties(PDOptionalContentProperties) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the optional content properties dictionary.
setOddPageOverlayFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the odd page overlay file.
setOddPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.util.Overlay
Sets the odd page overlay PDF.
setOffset(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
The offset attribute.
setOnNewLine(boolean) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will set a flag telling if we are on a newline.
setOpacity(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the annotation opacity.
setOpen(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will set inital state of the annotation, open or closed.
setOpen(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set initial state of the annotation, open or closed.
setOpenAction(PDDestinationOrAction) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the Document Open Action for this object.
setOpenCount(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the open count.
setOpenInNewWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will specify the destination document to open in a new window.
setOpenInNewWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will specify the destination document to open in a new window.
setOperation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
Set the operation to perform..
setOption(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will set the string for an available option.
setOptions(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the options for the choice field.
setOptions(List) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
This will will set the list of options for this button.
setOS(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Indicates the operating system.
setOutputCondition(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
setOutputConditionIdentifier(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
setOutputFile(String) - Method in class org.apache.pdfbox.util.Overlay
Sets the output file.
setOutputIntents(List<PDOutputIntent>) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Replace the list of OutputIntents of the document.
setOverlayPosition(Overlay.Position) - Method in class org.apache.pdfbox.util.Overlay
Sets the overlay position.
setOverprint(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the overprint property.
setOverprintMode(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint mode(OPM).
setOverprintMode(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the overprint mode property.
setOwner(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Sets the owner of the attributes.
setOwnerKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the O entry in the standard encryption dictionary.
setOwnerKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will set the O entry in the standard encryption dictionary.
setOwnerPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property ownerPassword.
setP(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set a parameter string to be passed to the application designated by the F entry.
setP(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Set the P value.
setPaddings(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the paddings for four sides separately (Padding).
setPage(PDPage) - Method in class org.apache.pdfbox.pdfviewer.PDFPagePanel
This will set the page that should be displayed in this panel.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
Sets the page.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the page on which some or all of the content items designated by the K entry shall be rendered (Pg).
setPage(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
This will set the page.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the corresponding page for this annotation.
setPage(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Set the 1-based page number.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets document page
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Set the page for this destination.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the page that this bead is part of.
setPageBreak() - Method in class org.apache.pdfbox.util.PositionWrapper
Sets the isPageBreak() flag to true.
setPageEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the end of a page.
setPageInfo(FDFPageInfo) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
This will set the page info.
setPageLabels(PDPageLabels) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the page label descriptor for the document.
setPageLayout(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the page layout.
setPageMode(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the page mode.
setPageNumber(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Set the page number for this destination.
setPages(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of pages.
setPageSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Deprecated.
use #setPageStart(String) and {@link #setPageEnd(String)} instead
setPageStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the beginning of a page.
setPaintType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will set the paint type.
setPaintType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the paint type.
setParagraphEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the end of a paragraph.
setParagraphStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Sets the string which will be used at the beginning of a paragraph.
setParagraphStart() - Method in class org.apache.pdfbox.util.PositionWrapper
sets the isParagraphStart() flag to true.
setParent(PDNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Sets the parent to the given node.
setParent(PDStructureNode) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the parent in the structure hierarchy (P).
setParent(PDAnnotationMarkup) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
This will set the markup annotation which this popup relates to.
setParent(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Set the parent of this object, this is maintained by these objects and should not be called by any clients of PDFBox code.
setParent(PDField) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Set the parent of this field.
setParent(PDPageNode) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the parent of this page.
setParent(PDPageNode) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will set the parent of this page.
setParentTree(PDNumberTreeNode) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the parent tree.
setParentTreeNextKey(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the next key in the parent tree.
setParser(ConformingPDFParser) - Method in class org.apache.pdfbox.cos.COSUnread
 
setParser(ConformingPDFParser) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
 
setPartialFieldName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the partial field name.
setPartialName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the partial name of the field.
setPassword(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the password bit.
setPattern(PDPatternResources) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
This will update the current pattern.
setPatterns(Map<String, PDPatternResources>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of patterns.
setPatternType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
This will set the pattern type.
setPC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is closed.
setPdfSource(long) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
Sets BaseParser.pdfSource to start next parsing at given file offset.
setPDPropBuildApp(PDPropBuildDataDict) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Set the build data dictionary for the viewing application software module.
setPDPropBuildFilter(PDPropBuildDataDict) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Set the build data dictionary for the signature handler.
setPDPropBuildPubSec(PDPropBuildDataDict) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Set the build data dictionary for the PubSec Software module.
setPdSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets PDSignature
setPdVisibleSignature(PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
Sets visible signature configuration Object
setPermission(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
Set the access permission granted to the recipient.
setPermissions(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the permissions bit mask.
setPermissions(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will set the permissions bit mask.
setPermissions(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property permissions.
setPhaseStart(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
This will set the line dash pattern phase.
setPI(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.
setPlacement(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the positioning of the element with respect to the enclosing reference area and other content (Placement).
setPO(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation is opened.
setPopup(PDAnnotationPopup) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the popup annotation used for entering/editing the text for this annotation.
setPos(long) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will set the current position in the stream.
setPreferedSignatureSize(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Set the preferred size of the signature.
setPrefix(String) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Sets the page label prefix for this page range.
setPreRelease(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
A flag that can be used by the signature handler or software module to indicate that this signature was created with unrelease software.
setPreviousBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the previous bead in the thread.
setPreviousSibling(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the previous sibling, this will be maintained by this class.
setPreviousURI(PDActionURI) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the previous URI action, in case it needs to be retrieved at later date.
setPrintArea(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setPrintArea(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintArea preference.
setPrintClip(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setPrintClip(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintClip preference.
setPrinted(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the printed flag.
setPrinted(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the printed flag.
setPrintScaling(PDViewerPreferences.PRINT_SCALING) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintScaling preference.
setProcSet(COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets ProcSet Array
setProducer(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the producer of the document.
setPropBuild(PDPropBuild) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
PDF signature build dictionary.
setProperties(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the dictionary mapping resource names to property list dictionaries for marked content.
setPV(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.
setQ(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
This will set the quadding/justification of the text.
setQuadPoints(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
This will set the set of quadpoints which encompass the areas of this annotation which will activate.
setQuadPoints(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will set the set of quadpoints which encompass the areas of this annotation.
setR(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
This will set the r value of the tristimulus.
setRadiosInUnison(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
From the PDF Spec
If set, a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked.
setRangeForComponent(PDRange, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
This will set the a range for this color space.
setRangeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
This will set the range values.
setReadingDirection(PDViewerPreferences.READING_DIRECTION) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the reading direction preference.
setReadingDirection(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setReadOnly() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Locks the access permission read only (ie, the setters will have no effects).
setReadOnly(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the readOnly flag.
setReadOnly(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the readOnly flag.
setReadonly(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
sets the field to be read-only.
setReason(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Sets the reason.
setReasonRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the Reason shall be required.
setReasonsd(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) An array of text strings that specifying possible reasons for signing a document.
setRecipients(byte[][]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the Recipients field of the dictionary.
setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the rectangle associated with this annotation.
setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the rectangle for this annotation.
setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the rectangle on the page that this bead covers.
setRectDifference(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the rectangle difference rectangle.
setRecursivlyRead(boolean) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
 
setReferencedObject(PDAnnotation) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Sets the referenced annotation.
setReferencedObject(PDXObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
Sets the referenced XObject.
setRegistryName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
setRename(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will set if the fields can be renamed.
setRenderingIntent(String) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will set the rendering intent for the graphics state.
setRenderingIntent(String) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the rendering intent.
setRenderingMode(int) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the renderingMode.
setReplyType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
setRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
sets the field to be required.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the resources for this pattern.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will set the resources for this page.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
This will set the new resources.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the resources for this page.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will set the resources for this page.
setRevision(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the R entry of the encryption dictionary.
setRevision(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will set the R entry of the encryption dictionary.
setRevision(long) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
The software module revision number, corresponding to the Date attribute.
setRevisionNumber(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the revision number (R).
setRevisionNumber(T, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Sets the revision number of a specified object.
setRichContents(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the rich text stream which is displayed in the popup window.
setRichText(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the rich text value.
setRichText(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the richText bit.
setRight(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.
setRise(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the rise.
setRole(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
Sets the role.
setRoleMap(Map<String, String>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the role map.
setRolloverAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set a list of appearances.
setRolloverAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will set the rollover appearance when there is rollover appearance to be shown.
setRolloverCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the rollover caption.
setRotation(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
This will set the rotation.
setRotation(int) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the rotation for this page.
setRotation(int) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will set the rotation for this page.
setRowSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
setRowSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Sets the number of rows in the enclosing table that shall be spanned by the cell (RowSpan).
setRubyAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the justification of the lines within a ruby assembly (RubyAlign).
setRubyPosition(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the placement of the RT structure element relative to the RB element in a ruby assembly (RubyPosition).
setS(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will set the type of action that the actions dictionary describes.
setS(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will set the type of action that the actions dictionary describes.
setScaleOption(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will set the scale option for the icon.
setScaleRatio(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the scale ration.
setScaleToFitAnnotation(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will tell the icon to scale.
setScaleType(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will set the scale type.
setScope(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the scope (Scope).
setScope(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Sets the scope (Scope).
setScript(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSecurityHandler(SecurityHandler) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Sets security handler if none is set already.
setSeedValue(PDSeedValue) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
(Optional; PDF 1.)
setSerif(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setSetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setSetWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setSetWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setShading(PDShadingResources) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
This will set the shading resources for this pattern.
setShadings(Map<String, PDShadingResources>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of shadings.
setShadingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
This will set the shading type.
setShouldSeparateByBeads(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set if the text stripper should group the text output by a list of beads.
setSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will set the signature that is associated with this catalog.
setSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Add a signature dictionary to the signature field.
setSignatureField(PDSignatureField) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets signature field
setSignatureInterface(SignatureInterface) - Method in class org.apache.pdfbox.cos.COSDocument
Set the signature interface to the given value.
setSignatureRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets SignatureRectangle
setSignDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Set the sign date.
setSize(long) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Set the size of the XRef stream.
setSize(int) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the size of the embedded file.
setSmallCap(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSmoothness(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the smoothness property.
setSmoothnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the smoothness tolerance.
setSortByPosition(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
The order of the text tokens in a PDF file may not be in the same as they appear visually on the screen.
setSpaceAfter(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
setSpaceAfter(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the amount of extra space following the after edge of the BLSE in the block-progression direction (SpaceAfter).
setSpaceBefore(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
setSpaceBefore(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the amount of extra space preceding the before edge of the BLSE in the block-progression direction (SpaceBefore).
setSpacingTolerance(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the space width-based tolerance value that is used to estimate where spaces in text should be added.
setSplitAtPage(int) - Method in class org.apache.pdfbox.util.Splitter
This will tell the splitting algorithm where to split the pages.
setStart(int) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Sets the start value for page numbering in this page range.
setStartBookmark(PDOutlineItem) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the bookmark where text extraction should start, inclusive.
setStartColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
Sets the colour for the start edge.
setStartIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
setStartIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent).
setStartPage(int) - Method in class org.apache.pdfbox.util.PageExtractor
Sets the first page number to be extracted.
setStartPage(int) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will set the first page to be extracted by this class.
setStartPage(int) - Method in class org.apache.pdfbox.util.Splitter
This will set the start page.
setStartPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set the line ending style for the start point, see the LE_ constants for the possible values.
setStartXref(long) - Method in class org.apache.pdfbox.cos.COSDocument
This method set the startxref value of the document.
setStartxref(long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Sets the byte position of the first XRef (has to be called after very last startxref was read).
setStartxref(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will set the start xref.
setState(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set the annotation state.
setStateModel(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
This will set the annotation state model.
setStatus(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the status string.
setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the stem H for the font.
setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the stem H for the font.
setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the stem H for the font.
setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the stem V for the font.
setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the stem V for the font.
setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the stem V for the font.
setStencil(boolean) - Method in class org.apache.pdfbox.util.ImageParameters
Sets whether or not the image is a stencil.
setStencilColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the current non stroking colorstate.
setStream(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
This will set the stream.
setString(int, String) - Method in class org.apache.pdfbox.cos.COSArray
Set the value in the array as a string.
setString(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setString(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will convert the value to a COSString object.
setString(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Sets a string attribute value.
setStroke(BasicStroke) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
This will set the current stroke.
setStrokeAdjustment(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
set the value of the stroke adjustment.
setStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the stroking alpha constant.
SetStrokingCalRGBColor - Class in org.apache.pdfbox.util.operator
Structural modification of the PDFEngine class : the long sequence of conditions in processOperator is replaced by this strategy pattern.
SetStrokingCalRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingCalRGBColor
 
SetStrokingCMYKColor - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingCMYKColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingCMYKColor
 
setStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the color components of current stroking colorspace.
setStrokingColor(Color) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as RGB.
setStrokingColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as RGB, 0-255.
setStrokingColor(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as CMYK, 0-255.
setStrokingColor(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as CMYK, 0.0-1.0.
setStrokingColor(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as grayscale, 0-255.
setStrokingColor(double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color, specified as Grayscale 0.0-1.0.
SetStrokingColor - Class in org.apache.pdfbox.util.operator
Set the stroking color space.
SetStrokingColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingColor
 
setStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Set the stroking color space.
SetStrokingColorSpace - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingColorSpace() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingColorSpace
 
SetStrokingDeviceN - Class in org.apache.pdfbox.util.operator
 
SetStrokingDeviceN() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingDeviceN
 
SetStrokingGrayColor - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingGrayColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingGrayColor
 
SetStrokingICCBasedColor - Class in org.apache.pdfbox.util.operator
 
SetStrokingICCBasedColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingICCBasedColor
 
SetStrokingIndexed - Class in org.apache.pdfbox.util.operator
 
SetStrokingIndexed() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingIndexed
 
SetStrokingLabColor - Class in org.apache.pdfbox.util.operator
Sets the stroking color values for Lab colorspace.
SetStrokingLabColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingLabColor
 
setStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the overprint control(OP).
SetStrokingPattern - Class in org.apache.pdfbox.util.operator
Set the stroking pattern.
SetStrokingPattern() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingPattern
 
SetStrokingRGBColor - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetStrokingRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingRGBColor
 
SetStrokingSeparation - Class in org.apache.pdfbox.util.operator
 
SetStrokingSeparation() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingSeparation
 
setStructParent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
This will set the key for this XObject in the structural parent tree.
setStructParent(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the key for this annotation in the structural parent tree.
setStructParents(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
This will set the key for this XObjectForm in the structural parent tree.
setStructParents(int) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the key for this page in the structural parent tree.
setStructuredElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the structure element for this node.
setStructureElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Sets the structure element.
setStructureTreeRoot(PDStructureTreeRoot) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the document's structure tree root.
setStructureType(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the structure type (S).
setStyle(String) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Sets the numbering style for this page range.
setStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
This will set the border effect, see the STYLE_* constants for valid values.
setStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the border style, see the STYLE_* constants for valid values.
setSubFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
Set the subfilter entry of the encryption dictionary.
setSubFilter(List<COSName>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) An array of names indicating encodings to use when signing.
setSubFilter(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Set a subfilter that specify the signature that should be used.
setSubFilterRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the subfilter shall be required.
setSubject(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
A short description of the annotation.
setSubject(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
This will set the short description of the subject of the annotation.
setSubject(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the subject of the document.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Set the subtype for this embedded file.
setSubType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the type of action that the actions dictionary describes.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the sub type (and hence appearance, AP taking precedence) For this annotation.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
This will set the sub type (and hence appearance, AP taking precedence) For this annotation.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
This will set the subtype of the external data dictionary.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
This will set the subtype of the measure dictionary.
setSummary(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
Sets the summary of the table's purpose and structure.
setSummary(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
Sets the summary of the table’s purpose and structure.
setSuppressDuplicateOverlappingText(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
By default the text stripper will attempt to remove text that overlapps each other.
setSuspect(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set the value of the suspects property.
setSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setTarget(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the target frame in the browser to open this document.
setTBorderStyles(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the style of the border drawn on each edge of a table cell (TBorderStyle).
setTempDirectory(File) - Method in class org.apache.pdfbox.pdfparser.PDFParser
This is the directory where pdfbox will create a temporary file for storing pdf document stream in.
setTemplate(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Wets PDDocument template.
setTemplateReference(FDFNamedPageReference) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will set the template reference.
setTemplates(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
A list of FDFTemplate objects.
setTerminator(char) - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will set the terminating character.
setTextAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the alignment, in the inline-progression direction, of text and other content within lines of the BLSE (TextAlign).
setTextColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the text color for this node.
setTextColor(Color) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the text color for this node.
setTextDecorationColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the colour to be used for drawing text decorations (TextDecorationColor).
setTextDecorationThickness(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
setTextDecorationThickness(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the thickness of each line drawn as part of the text decoration (TextDecorationThickness).
setTextDecorationType(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the type of text decoration (TextDecorationType).
SetTextFont - Class in org.apache.pdfbox.util.operator
 
SetTextFont() - Constructor for class org.apache.pdfbox.util.operator.SetTextFont
 
setTextIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets 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).
setTextIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets 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).
setTextKnockoutFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
This will get the text knockout flag.
SetTextLeading - Class in org.apache.pdfbox.util.operator
 
SetTextLeading() - Constructor for class org.apache.pdfbox.util.operator.SetTextLeading
 
setTextLineMatrix(Matrix) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
setTextMatrix(double, double, double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Tm operator.
setTextMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Tm operator.
setTextMatrix(Matrix) - Method in class org.apache.pdfbox.util.PDFStreamEngine
 
SetTextRenderingMode - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetTextRenderingMode() - Constructor for class org.apache.pdfbox.util.operator.SetTextRenderingMode
 
SetTextRise - Class in org.apache.pdfbox.util.operator
Structal modification of the PDFEngine class : the long sequence of conditions in processOperator is remplaced by this strategy pattern.
SetTextRise() - Constructor for class org.apache.pdfbox.util.operator.SetTextRise
 
setTextRotation(double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Tm operator.
setTextScaling(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Tm operator.
setTextState(PDTextState) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
This will set the graphics text state.
setTextTranslation(double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
The Tm operator.
setThousandsSeparator(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the text to be used between orders of thousands in display of numerical values.
setThread(PDThread) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the thread that this bead is part of.
setThreadBeads(List<PDThreadBead>) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the list of thread beads.
setThreadInfo(PDDocumentInformation) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
Set the thread info, can be null.
setThreads(List) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the list of threads for this pdf document.
setTilingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the tiling type.
setTimeStamp(PDSeedValueTimeStamp) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional; PDF 1.6) A time stamp dictionary containing two entries.
setTimestampRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Sets if a timestamp is reuqired or not.
setTintTransform(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
This will set the tint transform function.
setTintTransform(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
This will set the tint transform function.
setTitle(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the title (T).
setTitle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set a unique title for an annotation.
setTitle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the title for this node.
setTitle(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the title of the document.
setTitlePopup(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
setToggleNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the toggleNoView flag.
setToggleNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the toggleNoView flag.
setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.
setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the top y-coordinate, values 0 or -1 imply that the current y-coordinate will be used.
setToUnicode(COSBase) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will set the ToUnicode object.
setTPaddings(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the table paddings for four sides separately (TPadding).
setTrackMousePosition(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will specify whether to track the mouse position when the URI is resolved.
setTrailer(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDocument
// MIT added, maybe this should not be supported as trailer is a persistence construct.
setTrailer(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Adds trailer information for current XRef object.
setTrapped(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the trapped of the document.
setTrimBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the TrimBox for this page.
setTrustedMode(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
If true, the application was in trusted mode when signing took place.
setType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
This will set the type of PDF object that the actions dictionary describes.
setType(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Set the dictionary type.
setU(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the mouse button is released inside the annotation's active area.
setUnits(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the label for the units.
setUpperRightX(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will set the upper right x coordinate.
setUpperRightY(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will set the upper right y coordinate.
setURI(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
setURI(PDURIDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the document level uri.
setURL(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Sets the URL.
setUserKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the U entry in the standard encryption dictionary.
setUserKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
Deprecated.
This will set the U entry in the standard encryption dictionary.
setUserPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Setter of the property userPassword.
setUserProperties(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Set if the structure elements contain user properties.
setUserProperties(List<PDUserProperty>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Sets the user properties.
setV(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
This will set a JavaScript action to be performed when the field's value is changed.
setV(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) The minimum required capability of the signature field seed value dictionary parser.
setValue(float) - Method in class org.apache.pdfbox.cos.COSFloat
Set the value of the float object.
setValue(long) - Method in class org.apache.pdfbox.cos.COSInteger
Change the value of this reference.
setValue(Object) - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
This will set the value for this entry.
setValue(Object) - Method in class org.apache.pdfbox.pdfviewer.MapEntry
This will set the value for this entry.
setValue(int, int, float) - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
This will set a value at a position.
setValue(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Sets the property value.
setValue(Object) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
You should pass in a string, or a java.util.List of strings to set the value.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
setValue sets the fields value to a given string.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
 
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
setValue sets the fields value to a given string.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
This setValue method iterates the collection of radiobuttons and checks or unchecks each radiobutton according to the given value.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
Deprecated.
 
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Deprecated.
use setSignature(PDSignature) instead
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
setValue sets the fields value to a given string.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
setValue(int, int, float) - Method in class org.apache.pdfbox.util.Matrix
This will set a value at a position.
setVersion(float) - Method in class org.apache.pdfbox.cos.COSDocument
This will set the version of this PDF document and update the header string.
setVersion(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
This will set the V entry of the encryption dictionary.
setVersion(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will set the version of the FDF document.
setVersion(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary.
setVersion(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the PDF specification version this document conforms to.
setVerticesPerRow(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
Set the number of vertices per row.
setViewArea(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setViewArea(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the ViewArea preference.
setViewClip(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the ViewClip preference.
setViewClip(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Deprecated. 
setViewerPreferences(PDViewerPreferences) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Set the viewer preferences.
setVisibleSignature(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets configuration object of visible signature
setVisualSignature(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Reads the visual signature from the given input stream.
setVisualSignature(PDVisibleSigProperties) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Reads the visual signature from the given visual signature properties
setVisualSignature(COSDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets COSDocument of visible Signature.
setVolatile(boolean) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Tell if the underlying file is volatile and should not be cached by the reader application.
setVRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the V entry shall be required.
setWarnMissingClose(boolean) - Method in class org.apache.pdfbox.cos.COSDocument
Controls whether this instance shall issue a warning if the PDF document wasn't closed properly through a call to the COSDocument.close() method.
setWC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before closing a document.
setWhitepoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
This will set the whitepoint tristimulus.
setWhitepoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
This will set the whitepoint tristimulus.
setWhitePoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will set the whitepoint tristimulus.
setWidgetDictionary(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets Widget Dictionary.
setWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the widget field flags that are associated with this field.
setWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the field flags that are associated with this field.
setWidth(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the width of the element's content rectangle in the inline-progression direction (Width).
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the width of the element's content rectangle in the inline-progression direction (Width).
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
 
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Set the width of the image.
setWidth(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the border width in points, 0 = no border.
setWidth(int) - Method in class org.apache.pdfbox.util.ImageParameters
Set the width of the image.
setWidthAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the width of the element's content rectangle in the inline-progression direction (Width) to PDLayoutAttributeObject.WIDTH_AUTO.
setWidths(List<Float>) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Set the widths of the characters code.
setWinLaunchParams(PDWindowsLaunchParams) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will set a dictionary containing Windows-specific launch parameters.
setWordSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Set the desired word separator for output text.
setWordSpacing(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
Set the value of the wordSpacing.
SetWordSpacing - Class in org.apache.pdfbox.util.operator
 
SetWordSpacing() - Constructor for class org.apache.pdfbox.util.operator.SetWordSpacing
 
setWP(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before printing a document.
setWritingMode(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the writing mode (WritingMode).
setWS(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will set a JavaScript action to be performed before saving a document.
setX(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the x value of the tristimulus.
setX(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
This will set an action to be performed when the cursor exits the annotation's active area.
setX509(X509Certificate) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
Set the X509 certificate of the recipient.
setXFA(PDXFA) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the XFA resource, this is only used for PDF 1.5+ forms.
setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the x height for the font.
setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
This will set the x height for the font.
setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
This will set the x height for the font.
setXObjects(Map<String, PDXObject>) - Method in class org.apache.pdfbox.pdmodel.PDResources
This will set the map of xobjects.
setXRef(COSObjectKey, long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Populate XRef HashMap of current XRef object.
setXStep(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the XStep value.
setY(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the y value of the tristimulus.
setYStep(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
This will set the YStep value.
setZ(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
This will set the z value of the tristimulus.
setZoom(float) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Set the zoom value for the page, values 0 or -1 imply that the current zoom will be used.
SHADING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
shading - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
SHADING_PATTERN - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
 
SHADING_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SHADING_TYPE1 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 1 = function based shading.
SHADING_TYPE2 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 2 = axial shading.
SHADING_TYPE3 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 3 = radial shading.
SHADING_TYPE4 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 4 = Free-Form Gouraud-Shaded Triangle Meshes.
SHADING_TYPE5 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 5 = Lattice-Form Gouraud-Shaded Triangle Meshes.
SHADING_TYPE6 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 6 = Coons Patch Meshes.
SHADING_TYPE7 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
shading type 7 = Tensor-Product Patch Meshes.
shadingColorSpace - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
ShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
A base class to handle stuff that is common to all shading types.
ShadingContext(PDShadingResources, ColorModel, AffineTransform, Matrix, int, Rectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
shadingTinttransform - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
SHFill(COSName) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Deprecated.
shFill(COSName) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with Shading.
SHFill - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of sh operator for page drawer.
SHFill() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SHFill
 
SHFill_Axial(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with an Axial Shading.
SHFill_CoonsPatch(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Coons patch mesh If extending the class, override this and its siblings, not the public SHFill method.
SHFill_FreeGourad(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Free-form Gourad-shaded triangle mesh.
SHFill_Function(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Function-based gradient / shading.
SHFill_LatticeGourad(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Lattice-form Gourad-shaded triangle mesh.
SHFill_Radial(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Radial gradient / shading.
SHFill_TensorPatch(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Fill with a Tensor-product patch mesh.
shouldComb() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
shouldOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This will specify whether to open the destination document in a new window.
shouldOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This will specify whether to open the destination document in a new window.
shouldRename() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
A flag telling if the fields imported from the template may be renamed if there are conflicts.
shouldScaleToFitAnnotation() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
This will tell if the icon should scale to fit the annotation bounds.
shouldTrackMousePosition() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This will specify whether to track the mouse position when the URI is resolved.
ShowText - Class in org.apache.pdfbox.util.operator
 
ShowText() - Constructor for class org.apache.pdfbox.util.operator.ShowText
 
ShowTextGlyph - Class in org.apache.pdfbox.util.operator
 
ShowTextGlyph() - Constructor for class org.apache.pdfbox.util.operator.ShowTextGlyph
 
SIG - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SIG_FLAGS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
sign(InputStream) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface
Creates a cms signature for the given content
SignatureException - Exception in org.apache.pdfbox.exceptions
An exception that indicates a problem during the signing process.
SignatureException(String) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
Constructor.
SignatureException(int, String) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
Constructor.
SignatureException(Throwable) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
Constructor.
SignatureException(int, Throwable) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
Constructor.
signatureFieldName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
signatureImage(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
SignatureInterface - Interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature
Providing an interface for accessing necessary functions for signing a pdf document.
SignatureOptions - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This contains the visual signature as a COSDocument, its preferred size and the page.
SignatureOptions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
 
signatureReason(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets reason of signing
signatureText(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
signerLocation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
Sets location
signerName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
Sets signer name
silentPrint() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will send the PDF to the default printer without prompting the user for any printer settings.
silentPrint(PrinterJob) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will send the PDF to the default printer without prompting the user for any printer settings.
SingleByteCharset - Class in org.apache.pdfbox.encoding
Charset implementation for the single-byte encodings.
SingleByteCharset(String, String[], char[]) - Constructor for class org.apache.pdfbox.encoding.SingleByteCharset
Creates a new single-byte charset using an array of unicode characters.
size() - Method in class org.apache.pdfbox.cos.COSArray
This will get the size of this array.
size() - Method in class org.apache.pdfbox.cos.COSDictionary
This will return the number of elements in this dictionary.
SIZE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
size() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Totally available bytes in the underlying array.
size() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
size() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
size() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Returns the size.
skip(long) - Method in class org.apache.pdfbox.io.ASCII85InputStream
Unsupported.
skip(long) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Skips over and discards n bytes of data from this input stream.
skip(long) - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
 
skip(long) - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
skipOptionals(String, ParsePosition, String) - Static method in class org.apache.pdfbox.util.DateConverter
Advances the ParsePosition past any and all the characters that match those in the optionals list.
skipSpaces() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will skip all spaces and comments that are present.
skipString(String, String, ParsePosition) - Static method in class org.apache.pdfbox.util.DateConverter
If the victim string is at the given position in the text, this method advances the position past that string.
SM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SMASK - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
sort(List<T>, Comparator<T>) - Static method in class org.apache.pdfbox.util.QuickSort
Sorts the given list using the given comparator.
sort(List<T>) - Static method in class org.apache.pdfbox.util.QuickSort
Sorts the given list using compareTo as comparator.
sourceDocument - Variable in class org.apache.pdfbox.util.PageExtractor
 
SPACE - Static variable in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
space character.
SPACE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
space character.
SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Span
split(PDDocument) - Method in class org.apache.pdfbox.util.Splitter
This will take a document and split into several other documents.
Splitter - Class in org.apache.pdfbox.util
Split a document into several other documents.
Splitter() - Constructor for class org.apache.pdfbox.util.Splitter
 
STANDARD_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
StandardDecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
Represents the necessary information to decrypt a document protected by the standard security handler (password protection).
StandardDecryptionMaterial(String) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
Create a new standard decryption material with the given password.
StandardEncoding - Class in org.apache.pdfbox.encoding
This is an interface to a text encoder.
StandardEncoding() - Constructor for class org.apache.pdfbox.encoding.StandardEncoding
Constructor.
StandardProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
This class represents the protection policy to add to a document for password-based protection.
StandardProtectionPolicy(String, String, AccessPermission) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Creates an new instance of the standard protection policy in order to protect a PDF document with passwords.
StandardSecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
The class implements the standard security handler as decribed in the PDF specifications.
StandardSecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Constructor.
StandardSecurityHandler(StandardProtectionPolicy) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Constructor used for encryption.
StandardStructureTypes - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
The standard structure types.
startArticle(boolean) - Method in class org.apache.pdfbox.util.PDFText2HTML
Write out the article separator (div tag) with proper text direction information.
startArticle() - Method in class org.apache.pdfbox.util.PDFTextStripper
Start a new article, which is typically defined as a column on a single page (also referred to as a bead).
startArticle(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
Start a new article, which is typically defined as a column on a single page (also referred to as a bead).
startDocument(PDDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
This method is available for subclasses of this class.
startExtraction(String[]) - Method in class org.apache.pdfbox.ExtractText
Starts the text extraction.
startPage - Variable in class org.apache.pdfbox.util.PageExtractor
 
startPage(PDPage) - Method in class org.apache.pdfbox.util.PDFTextStripper
Start a new page.
STARTXREF - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The start xref token.
STARTXREF_MARKER - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
StartXRef-marker.
STATUS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STD_CF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STEM_H - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STEM_V - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STM_F - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STR_F - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STREAM - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The open stream token.
STRING_CLOSE - Static variable in class org.apache.pdfbox.cos.COSString
One of the close string tokens.
STRING_OPEN - Static variable in class org.apache.pdfbox.cos.COSString
One of the open string tokens.
StringUtil - Class in org.apache.pdfbox.util
 
StringUtil() - Constructor for class org.apache.pdfbox.util.StringUtil
 
stroke() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
Stroke the path.
strokePath() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
Stroke the path.
StrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
Implementation of content stream operator for page drawer.
StrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.StrokePath
 
STRUCT_PARENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STRUCT_PARENTS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STRUCT_TREE_ROOT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
STYLE_BEVELED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a beveled style.
STYLE_CLOUDY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constant for the name of a cloudy effect.
STYLE_DASHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a dashed style.
STYLE_DECIMAL - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Decimal page numbering style (1, 2, 3, ...).
STYLE_INSET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a inset style.
STYLE_LETTERS_LOWER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa, ...).
STYLE_LETTERS_UPPER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA, ...).
STYLE_ROMAN_LOWER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).
STYLE_ROMAN_UPPER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Roman numbers (upper case) numbering style (I, II, III, IV, ...).
STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
Constant for the name for no effect.
STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a solid style.
STYLE_UNDERLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
Constant for the name of a underline style.
Sub - Class in org.apache.pdfbox.pdmodel.graphics.predictor
The sub algorithm.
Sub() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Sub
 
SUB_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
The XObject subtype.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
The XObject subtype.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionNamed
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
The type of annotation.
SUB_TYPE_CARET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an Caret type of annotation.
SUB_TYPE_CIRCLE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Constant for an Eliptical type of annotation.
SUB_TYPE_FREETEXT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for a FreeText type of annotation.
SUB_TYPE_HIGHLIGHT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_INK - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an Ink type of annotation.
SUB_TYPE_POLYGON - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an Polygon type of annotation.
SUB_TYPE_POLYLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an PolyLine type of annotation.
SUB_TYPE_SOUND - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
Constant for an Sound type of annotation.
SUB_TYPE_SQUARE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
Constant for a Rectangular type of annotation.
SUB_TYPE_SQUIGGLY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_STRIKEOUT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUB_TYPE_UNDERLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
The types of annotation.
SUBFILTER - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SUBFILTER_ADBE_PKCS7_DETACHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature subfilter value.
SUBFILTER_ADBE_PKCS7_SHA1 - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature subfilter value.
SUBFILTER_ADBE_X509_RSA_SHA1 - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature subfilter value.
SUBFILTER_ETSI_CADES_DETACHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature subfilter value.
SUBJ - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SUBJECT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
subList(int, int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
substituteCMap(String) - Static method in class org.apache.pdfbox.encoding.conversion.CMapSubstitution
 
SUBTYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFileAttachment
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSound
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStamp
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline
COS Model value for SubType entry.
SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
The subtype of the rectlinear measure dictionary.
SUMMARY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
SUPPLEMENT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SV - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
SYMBOL - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
SYSPROP_EOFLOOKUPRANGE - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
 
SYSPROP_PARSEMINIMAL - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
 
systemLineSeparator - Variable in class org.apache.pdfbox.util.PDFTextStripper
The platforms line separator.

T

T - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
T_BODY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TBody
T_FOOT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TFoot
T_HEAD - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
THead
TABLE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Table
TABLE - Static variable in class org.apache.pdfbox.persistence.util.COSHEXTable
ASCII byte values for the hex strings.
TARGET - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TD - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TD
TEXT_ALIGN_CENTER - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextAlign: Center: Centered between the start and end edges.
TEXT_ALIGN_END - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextAlign: End: Aligned with the end edge.
TEXT_ALIGN_JUSTIFY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextAlign: Justify: Aligned with both the start and end edges, with internal spacing within each line expanded, if necessary, to achieve such alignment.
TEXT_ALIGN_START - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextAlign: Start: Aligned with the start edge.
TEXT_DECORATION_TYPE_LINE_THROUGH - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextDecorationType: LineThrough: A line through the middle of the text
TEXT_DECORATION_TYPE_NONE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextDecorationType: None: No text decoration
TEXT_DECORATION_TYPE_OVERLINE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextDecorationType: Overline: A line above the text
TEXT_DECORATION_TYPE_UNDERLINE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
TextDecorationType: Underline: A line below the text
TextNormalize - Class in org.apache.pdfbox.util
This class allows a caller to normalize text in various ways.
TextNormalize(String) - Constructor for class org.apache.pdfbox.util.TextNormalize
 
TextPosition - Class in org.apache.pdfbox.util
This represents a string and a position on the screen of those characters.
TextPosition() - Constructor for class org.apache.pdfbox.util.TextPosition
Constructor.
TextPosition(PDPage, Matrix, Matrix, float, float[], float, String, PDFont, float, int, float) - Constructor for class org.apache.pdfbox.util.TextPosition
Constructor.
TextPosition(int, float, float, Matrix, Matrix, float, float, float, String, PDFont, float, int) - Constructor for class org.apache.pdfbox.util.TextPosition
TextPosition(int, float, float, Matrix, float, float, float, float, float, String, PDFont, float, int) - Constructor for class org.apache.pdfbox.util.TextPosition
TextPosition(int, float, float, Matrix, float, float, float, float, float, String, int[], PDFont, float, int) - Constructor for class org.apache.pdfbox.util.TextPosition
Constructor.
TextPositionComparator - Class in org.apache.pdfbox.util
This class is a comparator for TextPosition operators.
TextPositionComparator() - Constructor for class org.apache.pdfbox.util.TextPositionComparator
 
TextToPDF - Class in org.apache.pdfbox
This will take a text file and ouput a pdf with that text.
TextToPDF() - Constructor for class org.apache.pdfbox.TextToPDF
 
TH - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TH
THREADS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
THREE - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number three.
TILING_PATTERN - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
 
TILING_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TIME_STAMP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TIMES_BOLD - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_BOLD_ITALIC - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_ITALIC - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TIMES_ROMAN - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
TITLE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TK - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TMP_FILE_PREFIX - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
 
TO_UNICODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
toArray() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
toArray(X[]) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
toBitString(byte) - Static method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Converts a byte to a "binary" String of 0s and 1s.
toBitString(byte[]) - Static method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Converts a series of bytes to a "binary" String of 0s and 1s.
toBitString(byte[], int, int) - Static method in class org.apache.pdfbox.io.ccitt.PackedBitArray
Converts a series of bytes to a "binary" String of 0s and 1s.
toByteArray(InputStream) - Static method in class org.apache.pdfbox.io.IOUtils
Reads the input stream and returns its contents as a byte array.
toByteArray() - Method in class org.apache.pdfbox.pdfwriter.COSFilterInputStream
 
TOC - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TOC
toCalendar(COSString) - Static method in class org.apache.pdfbox.util.DateConverter
Deprecated.
This method throws an IOException for failure. Replace calls to it with DateConverter.toCalendar(String, String[]) and test for failure with (value == null || value.get(Calendar.YEAR) == INVALID_YEAR)
toCalendar(String) - Static method in class org.apache.pdfbox.util.DateConverter
Deprecated.
This method throws an IOException for failure. Replace calls to it with DateConverter.toCalendar(String, String[]) using
null
for the second parameter and test for failure with (value == null || value.get(Calendar.YEAR) == INVALID_YEAR)
toCalendar(String, String[]) - Static method in class org.apache.pdfbox.util.DateConverter
Converts a string to a calendar.
TOCI - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TOCI
toCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
toCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
toCIEXYZ(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
toFloatArray() - Method in class org.apache.pdfbox.cos.COSArray
This will take an COSArray of numbers and convert it to a float[].
toISO8601(Calendar) - Static method in class org.apache.pdfbox.util.DateConverter
Converts the date to ISO 8601 string format: yyyy-mm-ddThh:MM:ss#hh:mm (where '#" is '+' or '-').
token(CharSequence) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Called when a token is encountered.
token(CharSequence) - Method in interface org.apache.pdfbox.pdmodel.common.function.type4.Parser.SyntaxHandler
Called when a token is encountered.
toList() - Method in class org.apache.pdfbox.cos.COSArray
Return contents of COSArray as a Java List.
toList() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
This will return then underlying COSArray.
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCalRGB
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceCMYK
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.ColorSpaceLab
toString() - Method in class org.apache.pdfbox.cos.COSArray
toString() - Method in class org.apache.pdfbox.cos.COSBoolean
Return a string representation of this object.
toString() - Method in class org.apache.pdfbox.cos.COSDictionary
toString() - Method in class org.apache.pdfbox.cos.COSFloat
toString() - Method in class org.apache.pdfbox.cos.COSInteger
toString() - Method in class org.apache.pdfbox.cos.COSName
toString() - Method in class org.apache.pdfbox.cos.COSObject
toString() - Method in class org.apache.pdfbox.cos.COSString
toString() - Method in class org.apache.pdfbox.cos.COSUnread
 
toString() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
toString() - Method in class org.apache.pdfbox.pdfviewer.MapEntry
This will output a string representation of this class.
toString() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
toString() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
toString() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
toString() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
This will return a string representation of this rectangle.
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
toString() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
Return a string representation of this class.
toString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will return a string representation of this field.
toString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
Deprecated.
Return a string rep of this object.
toString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Return a string rep of this object.
toString() - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
toString(Calendar) - Static method in class org.apache.pdfbox.util.DateConverter
Converts a Calendar to a string formatted as: D:yyyyMMddHHmmss#hh'mm' where # is Z, +, or -.
toString() - Method in class org.apache.pdfbox.util.Matrix
This will return a string representation of the matrix.
toString() - Method in class org.apache.pdfbox.util.PDFOperator
This will print a string rep of this class.
toString() - Method in class org.apache.pdfbox.util.TextPosition
Show the string data for this text position.
toUnicodeCmap - Variable in class org.apache.pdfbox.pdmodel.font.PDFont
The CMap holding the ToUnicode mapping.
TR - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TR
TRAILER - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The trailer token.
transformedPoint(double, double) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
use the current transformation matrix to transform a single point.
TRAPPED - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TRIM_BOX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TRUE - Static variable in class org.apache.pdfbox.cos.COSBoolean
The PDF true value.
TRUE_BYTES - Static variable in class org.apache.pdfbox.cos.COSBoolean
The true boolean token.
TRUE_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TRUSTED_MODE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TU - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TWO - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number two.
TYPE - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
 
TYPE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
TYPE of this object.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
 
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
The type of PDF object.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
The type of this destination.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
The type of this destination.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
The type of this destination.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
The type of this destination.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
The type of this destination.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
The type of the dictionary.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
The type of the dictionary.
TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
The type of this annotation.
TYPE0 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
TYPE1 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Type1Encoding - Class in org.apache.pdfbox.encoding
This class represents an encoding which was read from a type1 font.
Type1Encoding(int) - Constructor for class org.apache.pdfbox.encoding.Type1Encoding
 
Type1ShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for function-based (Type 1) shading.
Type1ShadingPaint(PDShadingType1, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.Type1ShadingPaint
Constructor.
TYPE3 - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
Type3StreamParser - Class in org.apache.pdfbox.pdmodel.font
This class will handle creating an image for a type 3 glyph.
Type3StreamParser() - Constructor for class org.apache.pdfbox.pdmodel.font.Type3StreamParser
 
Type4ShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for Gouraud Triangle Mesh (Type 4) shading.
Type4ShadingPaint(PDShadingType4, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.Type4ShadingPaint
Constructor.
Type5ShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT Paint for Gouraud Triangle Lattice (Type 5) shading.
Type5ShadingPaint(PDShadingType5, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.Type5ShadingPaint
Constructor.
Type6ShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT Paint for coons patch meshes (Type 6) shading.
Type6ShadingPaint(PDShadingType6, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.Type6ShadingPaint
Constructor.
Type7ShadingPaint - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT Paint for tensor-product patch meshes (Type 7) shading.
Type7ShadingPaint(PDShadingType7, Matrix, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.Type7ShadingPaint
Constructor.
TYPE_BOUNDED - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
The type of this destination.
TYPE_BOUNDED - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
The type of this destination.
TYPE_BOUNDED - Static variable in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
The type of this destination.
types - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
All standard structure types.

U

U - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
UF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
UNCHANGED - Static variable in class org.apache.pdfbox.cos.COSName
the COSName for the "Unchanged" value.
unCheck() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
Unchecks the radiobutton.
UNIX - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
UNKNOWN_FONT - Static variable in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
This is the key to a property in the PDFBox_External_Fonts.properties file to load a Font when a mapping does not exist for the current font.
unread(int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a byte.
unread(byte[], int, int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer.
unread(byte[]) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
Pushes back a portion of an array of bytes by copying it to the front of the pushback buffer.
unread(int) - Method in class org.apache.pdfbox.io.PushBackInputStream
unread(byte[]) - Method in class org.apache.pdfbox.io.PushBackInputStream
unread(byte[], int, int) - Method in class org.apache.pdfbox.io.PushBackInputStream
UNSPECIFIED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
An "unspecified" default float value.
UNSUPPORTED_OPERATION - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
Up - Class in org.apache.pdfbox.pdmodel.graphics.predictor
The up algorithm.
Up() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Up
 
updateCount() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
This will update the count attribute of the page node.
updateLastModified() - Method in class org.apache.pdfbox.pdmodel.PDPage
This will update the last modified time for the page object.
updateParentOpenCount(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
The count parameter needs to be updated when you add or remove elements to the outline.
URI - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
URL - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
userPropertyChanged(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
 
usesUserProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
Tells if structure elements use user properties.

V

V - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
valueForPathChanged(TreePath, Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
Messaged when the user has altered the value for the item identified by path to newValue.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
Returns the enum constant of this type with the specified name.
valueOf(COSName) - Static method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
Returns the base state represented by the given COSName.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.DUPLEX
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.PRINT_SCALING
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.util.Overlay.Position
Returns the enum constant of this type with the specified name.
values() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
values() - Static method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.DUPLEX
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.PRINT_SCALING
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.util.Overlay.Position
Returns an array containing the constants of this enum type, in the order they are declared.
VERISIGN_PPKVS - Static variable in class org.apache.pdfbox.cos.COSName
A signature filter value.
VERSION - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
VERSION - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The output version of the PDF.
version - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
The value of V field of the Encryption dictionary.
Version - Class in org.apache.pdfbox
A simple command line utility to get the version of PDFBox.
VERSION0_UNDOCUMENTED_UNSUPPORTED - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION1_40_BIT_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION2_VARIABLE_LENGTH_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION3_UNPUBLISHED_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERSION4_SECURITY_HANDLER - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
See PDF Reference 1.4 Table 3.13.
VERTICES_PER_ROW - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
VIEW_AREA - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
VIEW_CLIP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
VIEWER_PREFERENCES - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
visitFromArray(COSArray) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to Array object.
visitFromArray(COSArray) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromArray method comment.
visitFromBoolean(COSBoolean) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to boolean object.
visitFromBoolean(COSBoolean) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromBoolean method comment.
visitFromDictionary(COSDictionary) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to dictionary object.
visitFromDictionary(COSDictionary) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromDictionary method comment.
visitFromDocument(COSDocument) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to document object.
visitFromDocument(COSDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
The visit from document method.
visitFromFloat(COSFloat) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to float object.
visitFromFloat(COSFloat) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromFloat method comment.
visitFromInt(COSInteger) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to integer object.
visitFromInt(COSInteger) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromFloat method comment.
visitFromName(COSName) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to name object.
visitFromName(COSName) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromName method comment.
visitFromNull(COSNull) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to null object.
visitFromNull(COSNull) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromNull method comment.
visitFromStream(COSStream) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to stream object.
visitFromStream(COSStream) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromStream method comment.
visitFromString(COSString) - Method in interface org.apache.pdfbox.cos.ICOSVisitor
Notification of visit to string object.
visitFromString(COSString) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromString method comment.
VISUAL_SIGNATURE_INVALID - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
VisualSignatureParser - Class in org.apache.pdfbox.pdfparser
 
VisualSignatureParser(InputStream) - Constructor for class org.apache.pdfbox.pdfparser.VisualSignatureParser
Constructor.
visualSignEnabled(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets visible signature to be added or not

W

W - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
WARICHU - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Warichu
wasDecryptedWithOwnerPassword() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
use getCurrentAccessPermission instead
WHITE_MAKE_UP - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The white make-up code words.
WHITE_POINT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
WHITE_TERMINATING - Static variable in interface org.apache.pdfbox.io.ccitt.CCITTFaxConstants
The white terminating code words.
whitespace(CharSequence) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
Called when whitespace characters are encountered.
whitespace(CharSequence) - Method in interface org.apache.pdfbox.pdmodel.common.function.type4.Parser.SyntaxHandler
Called when whitespace characters are encountered.
WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
width(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
WIDTH_AUTO - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Width: Auto
WIDTHS - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
willEncryptWhenSaving() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Deprecated.
Do not rely on this method anymore. It is the responsibility of COSWriter to hold this state
WIN_ANSI_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
WinAnsiEncoding - Class in org.apache.pdfbox.encoding
This the win ansi encoding.
WinAnsiEncoding() - Constructor for class org.apache.pdfbox.encoding.WinAnsiEncoding
Constructor.
WP - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
WP
wrapInSaveRestore(PDPage) - Method in class org.apache.pdfbox.util.LayerUtility
Some applications may not wrap their page content in a save/restore (q/Q) pair which can lead to problems with coordinate system transformations when content is appended.
WrappedException - Exception in org.apache.pdfbox.exceptions
Deprecated.
java.lang.Exception itself has wrapper capabilities since Java 1.4
WrappedException(Exception) - Constructor for exception org.apache.pdfbox.exceptions.WrappedException
Deprecated.
constructor comment.
WrappedIOException - Exception in org.apache.pdfbox.exceptions
An simple class that allows a sub exception to be stored.
WrappedIOException(Throwable) - Constructor for exception org.apache.pdfbox.exceptions.WrappedIOException
constructor comment.
WrappedIOException(String, Throwable) - Constructor for exception org.apache.pdfbox.exceptions.WrappedIOException
constructor comment.
write(byte, OutputStream) - Method in class org.apache.pdfbox.encryption.ARCFour
This will encrypt and write the next byte.
write(byte[], OutputStream) - Method in class org.apache.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(InputStream, OutputStream) - Method in class org.apache.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(byte[], int, int, OutputStream) - Method in class org.apache.pdfbox.encryption.ARCFour
This will encrypt and write the data.
write(int) - Method in class org.apache.pdfbox.io.ASCII85OutputStream
This will write a single byte.
write(int) - Method in interface org.apache.pdfbox.io.RandomAccess
Write a byte to the stream.
write(byte[], int, int) - Method in interface org.apache.pdfbox.io.RandomAccess
Write a buffer of data to the stream.
write(int) - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Write a byte to the stream.
write(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessBuffer
Write a buffer of data to the stream.
write(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessFile
Write a buffer of data to the stream.
write(int) - Method in class org.apache.pdfbox.io.RandomAccessFile
Write a byte to the stream.
write(byte[], int, int) - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
write(int) - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
write(byte[], int, int) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write some byte to the stream.
write(int) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write a single byte to the stream.
write(COSDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the pdf document.
write(PDDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the pdf document.
write(int) - Method in class org.apache.pdfbox.util.NullOutputStream
 
write(byte[], int, int) - Method in class org.apache.pdfbox.util.NullOutputStream
 
write(byte[]) - Method in class org.apache.pdfbox.util.NullOutputStream
 
write2file(String) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".
write2file(File) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Writes the image to a file with the filename + an appropriate suffix, like "Image.jpg".
write2OutputStream(OutputStream) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
This writes a tiff to out.
write2OutputStream(OutputStream) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
This writes the JPeg to out.
write2OutputStream(OutputStream) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
Writes the image as .png.
write2OutputStream(OutputStream) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
Writes the Image to out.
writeCharacters(TextPosition) - Method in class org.apache.pdfbox.util.PDFTextStripper
Write the string in TextPosition to the output stream.
writeCRLF() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write a CRLF to the stream.
WriteDecodedDoc - Class in org.apache.pdfbox
load document and write with all streams decoded.
WriteDecodedDoc() - Constructor for class org.apache.pdfbox.WriteDecodedDoc
Constructor.
writeEOL() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write an EOL to the stream.
writeFont(Graphics2D, AffineTransform, float, float, GlyphVector) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
This will draw a string on a canvas using the font.
writeHeader() - Method in class org.apache.pdfbox.util.PDFText2HTML
Write the header to the output document.
writeImage(BufferedImage, String, int) - Static method in class org.apache.pdfbox.util.ImageIOUtil
Writes a buffered image to a file using the given image format.
writeImage(BufferedImage, String, String, int) - Static method in class org.apache.pdfbox.util.ImageIOUtil
Deprecated.
use ImageIOUtil.writeImage(BufferedImage image, String filename, int dpi), which uses the full filename instead of just the prefix.
writeImage(BufferedImage, String, OutputStream) - Static method in class org.apache.pdfbox.util.ImageIOUtil
Writes a buffered image to a file using the given image format.
writeImage(BufferedImage, String, OutputStream, int) - Static method in class org.apache.pdfbox.util.ImageIOUtil
Writes a buffered image to a file using the given image format.
writeImage(BufferedImage, String, OutputStream, int, float) - Static method in class org.apache.pdfbox.util.ImageIOUtil
Writes a buffered image to a file using the given image format.
writeImage(PDDocument, String, String, int, int, String) - Method in class org.apache.pdfbox.util.PDFImageWriter
Converts a given page range of a PDF document to bitmap images by calling PDFImageWriter.writeImage(PDDocument document, String imageFormat, String password, int startPage, int endPage, String outputPrefix, int imageType, int resolution) with imageType BufferedImage.TYPE_INT_RGB and screen resolution, or 96dpi if screen resolution is unavailable.
writeImage(PDDocument, String, String, int, int, String, int, int) - Method in class org.apache.pdfbox.util.PDFImageWriter
Converts a given page range of a PDF document to bitmap images.
writeJpeg2file(PDJpeg, String) - Method in class org.apache.pdfbox.ExtractImages
 
writeLF() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write a Linefeed to the stream.
writeLineSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write the line separator value to the output stream.
writePage() - Method in class org.apache.pdfbox.util.PDFText2HTML
This will print the text of the processed page to "output".
writePage() - Method in class org.apache.pdfbox.util.PDFTextStripper
This will print the text of the processed page to "output".
writePage() - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
This will print the processed page text to the output stream.
writePageEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write something (if defined) at the end of a page.
writePageSeperator() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write the page separator value to the output stream.
writePageStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write something (if defined) at the start of a page.
writeParagraphEnd() - Method in class org.apache.pdfbox.util.PDFText2HTML
Writes the paragraph end "" to the output.
writeParagraphEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write something (if defined) at the end of a paragraph.
writeParagraphSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
writes the paragraph separator string to the output.
writeParagraphStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write something (if defined) at the start of a paragraph.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSBoolean
This will write this object out to a PDF stream.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSFloat
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSInteger
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSName
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSNull
This will output this string as a PDF object.
writePDF(OutputStream) - Method in class org.apache.pdfbox.cos.COSString
This will output this string as a PDF object.
writeReference(COSBase) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromObjRef method comment.
writeString(String, List<TextPosition>) - Method in class org.apache.pdfbox.util.PDFText2HTML
Write a string to the output stream, maintain font state, and escape some HTML characters.
writeString(String) - Method in class org.apache.pdfbox.util.PDFText2HTML
Write a string to the output stream and escape some HTML characters.
writeString(String, List<TextPosition>) - Method in class org.apache.pdfbox.util.PDFTextStripper
Write a Java string to the output stream.
writeString(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
Write a Java string to the output stream.
writeText(COSDocument, Writer) - Method in class org.apache.pdfbox.util.PDFTextStripper
Deprecated. 
writeText(PDDocument, Writer) - Method in class org.apache.pdfbox.util.PDFTextStripper
This will take a PDDocument and write the text of that document to the print writer.
writeTokens(List, int, int) - Method in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
This will write out the list of tokens to the stream.
writeTokens(List) - Method in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
This will write out the list of tokens to the stream.
writeWordSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
Write the word separator value to the output stream.
writeXML(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will write this element as an XML document.
writeXML(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will write this element as an XML document.
writeXML(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
This will write this element as an XML document.
writeXML(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will write this element as an XML document.
WRITING_MODE_LRTB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
WritingMode: LrTb: Inline progression from left to right; block progression from top to bottom.
WRITING_MODE_RLTB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
WritingMode: RlTb: Inline progression from right to left; block progression from top to bottom.
WRITING_MODE_TBRL - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
WritingMode: TbRl: Inline progression from top to bottom; block progression from right to left.
WRONG_PASSWORD - Static variable in exception org.apache.pdfbox.exceptions.SignatureException
 
WT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
WT

X

X_STEP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
xAxis(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
XHEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
XMLUtil - Class in org.apache.pdfbox.util
This class with handle some simple XML operations.
XOBJECT - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
XOBJECT - Static variable in class org.apache.pdfbox.Overlay
Deprecated.
use the COSName.XOBJECT constant instead
xobject(PDXObject) - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
 
XREF - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
XREF - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The XREF token.
XREF_FREE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The xref free token.
XREF_STM - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
XREF_USED - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The xref used token.
XrefEntry - Class in org.apache.pdfbox.pdmodel.common
 
XrefEntry() - Constructor for class org.apache.pdfbox.pdmodel.common.XrefEntry
 
XrefEntry(int, int, int, String) - Constructor for class org.apache.pdfbox.pdmodel.common.XrefEntry
 
xrefTrailerResolver - Variable in class org.apache.pdfbox.pdfparser.PDFParser
Collects all Xref/trailer objects and resolves them into single object using startxref reference.
XrefTrailerResolver - Class in org.apache.pdfbox.pdfparser
This class will collect all XRef/trailer objects and creates correct xref/trailer information after all objects are read using startxref and 'Prev' information (unused XRef/trailer objects are discarded).
XrefTrailerResolver() - Constructor for class org.apache.pdfbox.pdfparser.XrefTrailerResolver
 

Y

Y_STEP - Static variable in class org.apache.pdfbox.cos.COSName
A common COSName value.
yAxis(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 

Z

ZAPF_DINGBATS - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
Standard Base 14 Font.
ZERO - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number zero.
ZERO - Static variable in class org.apache.pdfbox.cos.COSNumber
Deprecated.
Use the COSInteger.ZERO constant instead
zoom(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
zoom signature image with some percent.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 

Copyright © 2002–2017 The Apache Software Foundation. All rights reserved.