Skip navigation links
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 - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
A0 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A0 Paper.
A1 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A1 Paper.
A2 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A2 Paper.
A3 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A3 Paper.
A4 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A4 Paper.
A5 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A5 Paper.
A6 - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of A6 Paper.
AA - Static variable in class org.apache.pdfbox.cos.COSName
 
ABSOLUTE_COLORIMETRIC - Static variable in class org.apache.pdfbox.cos.COSName
 
AbstractFixup - Class in org.apache.pdfbox.pdmodel.fixup
 
AbstractFixup(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.AbstractFixup
 
AbstractProcessor - Class in org.apache.pdfbox.pdmodel.fixup.processor
 
AbstractProcessor(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.processor.AbstractProcessor
 
AbstractSyntaxHandler() - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
 
AbstractXReference - Class in org.apache.pdfbox.pdfparser.xref
An extending class represents an entry, as it can be found in a PDF's crossreference stream (PDFXRefStream).
AbstractXReference(XReferenceType) - Constructor for class org.apache.pdfbox.pdfparser.xref.AbstractXReference
Creates a crossreference stream entry of the given XReferenceType.
AC - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
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
 
accept(ICOSVisitor) - Method in class org.apache.pdfbox.cos.COSString
Visitor pattern double dispatch method.
accept(PDAnnotation) - Method in interface org.apache.pdfbox.pdmodel.interactive.annotation.AnnotationFilter
 
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
 
AcroFormDefaultFixup - Class in org.apache.pdfbox.pdmodel.fixup
 
AcroFormDefaultFixup(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.AcroFormDefaultFixup
 
AcroFormDefaultsProcessor - Class in org.apache.pdfbox.pdmodel.fixup.processor
Verify and ensure default resources for /AcroForm.
AcroFormDefaultsProcessor(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormDefaultsProcessor
 
AcroFormGenerateAppearancesProcessor - Class in org.apache.pdfbox.pdmodel.fixup.processor
 
AcroFormGenerateAppearancesProcessor(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormGenerateAppearancesProcessor
 
AcroFormOrphanWidgetsProcessor - Class in org.apache.pdfbox.pdmodel.fixup.processor
Generate field entries from page level widget annotations if there AcroForm /Fields entry is empty.
AcroFormOrphanWidgetsProcessor(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormOrphanWidgetsProcessor
 
action - Variable in class org.apache.pdfbox.pdmodel.interactive.action.PDAction
The action dictionary.
ACTUAL_TEXT - Static variable in class org.apache.pdfbox.cos.COSName
 
ADBE - Static variable in class org.apache.pdfbox.cos.COSName
 
ADBE_PKCS7_DETACHED - Static variable in class org.apache.pdfbox.cos.COSName
 
ADBE_PKCS7_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
 
ADBE_X509_RSA_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
 
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
add(int, String) - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
This will add a character encoding.
add(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Adds the given page to this page tree.
add(PDFont) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given font to the resources of the current page and returns the name for the new resources.
add(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given color space to the resources of the current page and returns the name for the new resources.
add(PDExtendedGraphicsState) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given extended graphics state to the resources of the current page and returns the name for the new resources.
add(PDShading) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given shading to the resources of the current page and returns the name for the new resources.
add(PDAbstractPattern) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given pattern to the resources of the current page and returns the name for the new resources.
add(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given property list to the resources of the current page and returns the name for the new resources.
add(PDImageXObject) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given image to the resources of the current page and returns the name for the new resources.
add(PDFormXObject) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given form to the resources of the current page and returns the name for the new resources.
add(PDXObject, String) - Method in class org.apache.pdfbox.pdmodel.PDResources
Adds the given XObject to the resources of the current page and returns the name for the new resources.
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 dictionaries 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.
addBoolean(boolean) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequence
Adds a bool value.
addClassName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Adds a class name.
addEntry(XReferenceEntry) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Add an new entry to the XRef stream.
addFirst(PDOutlineItem) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Adds the given node to the top of the children list.
addFont(FontInfo, FontBoxFont) - Method in class org.apache.pdfbox.pdmodel.font.FontCache
Adds the given FontBox font to the cache.
addGlyphsToSubset(Set<Integer>) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
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.
addIssuer(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
array of bytes containing DER-encoded X.509v3 certificates of acceptable issuers.
addKeyUsage(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional; PDF 1.7) specifies an acceptable key-usage extension that must be presennt in the signing certificate for works like PDSeedValueCertificate.setKeyUsage(List) but takes only one string
addKeyUsage(char, char, char, char, char, char, char, char, char) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
works like PDSeedValueCertificate.addKeyUsage(String) but enters each character separately
addLast(PDOutlineItem) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Adds the given node to the bottom of the children list.
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.
addObject(T, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Adds an object with a specified revision number.
addOID(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
works like PDSeedValueCertificate.setOID(List) but for one object
addOperator(OperatorProcessor) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Adds an operator processor to the engine.
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.
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.
addRegion(String, Rectangle2D) - Method in class org.apache.pdfbox.text.PDFTextStripperByArea
Add a new region to group text by.
addSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Add parameters of signature to be created externally using default signature options.
addSignature(PDSignature, SignatureOptions) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Add parameters of signature to be created externally.
addSignature(PDSignature, SignatureInterface) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Add a signature to be created using the instance of given interface.
addSignature(PDSignature, SignatureInterface, SignatureOptions) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will add a signature to the document.
addSource(String) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Add a source file to the list of files to merge.
addSource(File) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Add a source file to the list of files to merge.
addSource(RandomAccessRead) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Add a source to the list of documents to merge.
addSources(List<RandomAccessRead>) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Add a list of sources to the list of documents to merge.
addSubject(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional) byte array containing DER-encoded X.509v3 certificate that is acceptable for signing.
addText(TextPosition) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Adds a text position to the contents.
addToSubset(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Adds the given Unicode point to the subset.
addToSubset(int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
addToSubset(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
addTrailerInfo(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Copy all Trailer Information to this file.
addUserProperty(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Adds a user property.
addXObject(PDXObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Adds an XObject to the contents.
addXRefEntry(XReferenceEntry) - 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.
adjustForRotation() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Adjust signature for page rotation.
ADOBE_PPKLITE - Static variable in class org.apache.pdfbox.cos.COSName
 
AESV2 - Static variable in class org.apache.pdfbox.cos.COSName
 
AESV3 - Static variable in class org.apache.pdfbox.cos.COSName
 
AF - Static variable in class org.apache.pdfbox.cos.COSName
 
AF_RELATIONSHIP - Static variable in class org.apache.pdfbox.cos.COSName
 
AFTER - Static variable in class org.apache.pdfbox.cos.COSName
 
AI_META_DATA - Static variable in class org.apache.pdfbox.cos.COSName
 
AIS - Static variable in class org.apache.pdfbox.cos.COSName
 
ALL_OFF - Static variable in class org.apache.pdfbox.cos.COSName
 
ALL_ON - Static variable in class org.apache.pdfbox.cos.COSName
 
ALPHA - Static variable in class org.apache.pdfbox.cos.COSName
 
ALT - Static variable in class org.apache.pdfbox.cos.COSName
 
ALTERNATE - Static variable in class org.apache.pdfbox.cos.COSName
 
ANGLED_STYLES - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
Line ending styles where the shape changes its angle, e.g.
ANNOT - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
AnnotationFilter - Interface in org.apache.pdfbox.pdmodel.interactive.annotation
Simple interface allowing the use of an annotation filter visitor.
ANNOTS - Static variable in class org.apache.pdfbox.cos.COSName
 
ANTI_ALIAS - Static variable in class org.apache.pdfbox.cos.COSName
 
ANY_OFF - Static variable in class org.apache.pdfbox.cos.COSName
 
ANY_ON - Static variable in class org.apache.pdfbox.cos.COSName
 
AP - Static variable in class org.apache.pdfbox.cos.COSName
 
AP_REF - Static variable in class org.apache.pdfbox.cos.COSName
 
APP - Static variable in class org.apache.pdfbox.cos.COSName
 
AppearanceStyle - Class in org.apache.pdfbox.pdmodel.interactive.annotation.layout
Define styling attributes to be used for text formatting.
AppearanceStyle() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.layout.AppearanceStyle
 
APPEND_RECT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
appendBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Append a bead after this bead.
appendDocument(PDDocument, PDDocument) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
append all pages from source to destination.
appendFormAsLayer(PDPage, PDFormXObject, AffineTransform, String) - Method in class org.apache.pdfbox.multipdf.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(OutputStream, String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
appendRawCommands(String) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated.
Usage of this method is discouraged.
appendRawCommands(byte[]) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated.
Usage of this method is discouraged.
appendRawCommands(int) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated.
Usage of this method is discouraged.
appendRawCommands(double) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated.
Usage of this method is discouraged.
appendRawCommands(float) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated.
Usage of this method is discouraged.
appendRectangle(Point2D, Point2D, Point2D, Point2D) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Append a rectangle to the current path.
appendRectangle(Point2D, Point2D, Point2D, Point2D) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
AppendRectangleToPath - Class in org.apache.pdfbox.contentstream.operator.graphics
re Appends a rectangle to the path.
AppendRectangleToPath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.AppendRectangleToPath
 
apply() - Method in class org.apache.pdfbox.pdmodel.fixup.AcroFormDefaultFixup
 
apply() - Method in interface org.apache.pdfbox.pdmodel.fixup.PDDocumentFixup
 
applyChange() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
Applies a value change to the field.
applyTextAdjustment(float, float) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Applies a text position adjustment from the TJ operator.
array - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
 
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.
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
 
ARTIFACT - Static variable in class org.apache.pdfbox.cos.COSName
 
AS - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCENT - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCII85_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCII85_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCII_CR - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
ASCII code for carriage return.
ASCII_HEX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCII_HEX_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
ASCII_LF - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
ASCII code for line feed.
asUnmodifiableDictionary() - Method in class org.apache.pdfbox.cos.COSDictionary
Returns an unmodifiable view of this dictionary.
ATTACHED - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
AVG_WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
 
AxialShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for axial shading.
AxialShadingContext(PDShadingType2, ColorModel, AffineTransform, Matrix, 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.

B

B - Static variable in class org.apache.pdfbox.cos.COSName
 
B - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
BACKGROUND - Static variable in class org.apache.pdfbox.cos.COSName
 
BASE_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
BASE_FONT - Static variable in class org.apache.pdfbox.cos.COSName
 
BASE_STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
BASE_VERSION - Static variable in class org.apache.pdfbox.cos.COSName
 
BaseParser - Class in org.apache.pdfbox.pdfparser
This class is used to contain parsing logic that will be used by all parsers.
BBOX - Static variable in class org.apache.pdfbox.cos.COSName
 
BC - Static variable in class org.apache.pdfbox.cos.COSName
 
BE - Static variable in class org.apache.pdfbox.cos.COSName
 
BEAD - Static variable in class org.apache.pdfbox.cos.COSName
 
BEFORE - Static variable in class org.apache.pdfbox.cos.COSName
 
BEGIN_COMPATIBILITY_SECTION - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BEGIN_INLINE_IMAGE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BEGIN_INLINE_IMAGE_DATA - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BEGIN_MARKED_CONTENT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BEGIN_MARKED_CONTENT_SEQ - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BEGIN_TEXT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
BeginInlineImage - Class in org.apache.pdfbox.contentstream.operator.graphics
BI Begins an inline image.
BeginInlineImage(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.BeginInlineImage
 
BeginMarkedContentSequence - Class in org.apache.pdfbox.contentstream.operator.markedcontent
BMC : Begins a marked-content sequence.
BeginMarkedContentSequence(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequence
 
beginMarkedContentSequence(COSName, COSDictionary) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a marked content group begins
beginMarkedContentSequence(COSName, COSDictionary) - Method in class org.apache.pdfbox.rendering.PageDrawer
Called when a marked content group begins
beginMarkedContentSequence(COSName, COSDictionary) - Method in class org.apache.pdfbox.text.PDFMarkedContentExtractor
 
BeginMarkedContentSequenceWithProperties - Class in org.apache.pdfbox.contentstream.operator.markedcontent
BDC : Begins a marked-content sequence with property list.
BeginMarkedContentSequenceWithProperties(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequenceWithProperties
 
BeginText - Class in org.apache.pdfbox.contentstream.operator.text
BT: Begin text.
BeginText(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.BeginText
 
beginText() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when the BT operator is encountered.
beginText() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
bfSearchForObjStreams(XrefTrailerResolver, SecurityHandler<? extends ProtectionPolicy>) - Method in class org.apache.pdfbox.pdfparser.BruteForceParser
Brute force search for all objects streams of a pdf.
bfSearchForXRef(long) - Method in class org.apache.pdfbox.pdfparser.BruteForceParser
Search for the offset of the given xref table/stream among those found by a brute force search.
bfSearchTriggered() - Method in class org.apache.pdfbox.pdfparser.BruteForceParser
Indicates wether the brute force search for objects was triggered.
BG - Static variable in class org.apache.pdfbox.cos.COSName
 
BIB_ENTRY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
BibEntry
BITS_PER_COMPONENT - Static variable in class org.apache.pdfbox.cos.COSName
 
BITS_PER_COORDINATE - Static variable in class org.apache.pdfbox.cos.COSName
 
BITS_PER_FLAG - Static variable in class org.apache.pdfbox.cos.COSName
 
BITS_PER_SAMPLE - Static variable in class org.apache.pdfbox.cos.COSName
 
BL - Static variable in class org.apache.pdfbox.cos.COSName
 
BLACK_IS_1 - Static variable in class org.apache.pdfbox.cos.COSName
 
BLACK_POINT - Static variable in class org.apache.pdfbox.cos.COSName
 
BLEED_BOX - Static variable in class org.apache.pdfbox.cos.COSName
 
blend(float[], float[], float[]) - Method in interface org.apache.pdfbox.pdmodel.graphics.blend.BlendMode.BlendFunction
Blend function for non separable blend modes.
blendChannel(float, float) - Method in interface org.apache.pdfbox.pdmodel.graphics.blend.BlendMode.BlendChannelFunction
BlendChannel function for separable blend modes.
BlendComposite - Class in org.apache.pdfbox.pdmodel.graphics.blend
AWT composite for blend modes.
BlendMode - Class in org.apache.pdfbox.pdmodel.graphics.blend
Blend mode.
BlendMode.BlendChannelFunction - Interface in org.apache.pdfbox.pdmodel.graphics.blend
 
BlendMode.BlendFunction - Interface in org.apache.pdfbox.pdmodel.graphics.blend
 
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
BM - Static variable in class org.apache.pdfbox.cos.COSName
 
BORDER - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
BOUNDS - Static variable in class org.apache.pdfbox.cos.COSName
 
BPC - Static variable in class org.apache.pdfbox.cos.COSName
 
BruteForceParser - Class in org.apache.pdfbox.pdfparser
Brute force parser to be used as last resort if a malformed pdf can't be read.
BruteForceParser(RandomAccessRead, COSDocument) - Constructor for class org.apache.pdfbox.pdfparser.BruteForceParser
Constructor.
BS - Static variable in class org.apache.pdfbox.cos.COSName
 
BTN - Static variable in class org.apache.pdfbox.cos.COSName
 
build() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
Builder(PDAppearanceContentStream) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
buildPDF(PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateCreator
Build a PDF with a visible signature step by step, and return it as a stream.
buildSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
start building of visible signature
BuiltInEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
A font's built-in encoding.
BuiltInEncoding(Map<Integer, String>) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.BuiltInEncoding
Constructor.
BYTERANGE - Static variable in class org.apache.pdfbox.cos.COSName
 

C

C - Static variable in class org.apache.pdfbox.cos.COSName
 
C0 - Static variable in class org.apache.pdfbox.cos.COSName
 
C1 - Static variable in class org.apache.pdfbox.cos.COSName
 
CA - Static variable in class org.apache.pdfbox.cos.COSName
 
CA_NS - Static variable in class org.apache.pdfbox.cos.COSName
 
calculate(PDActionJavaScript, String) - Method in interface org.apache.pdfbox.pdmodel.interactive.form.ScriptingHandler
Handle the fields calculate event action.
calculateAffineTransform(PDPage, PDRectangle) - Method in class org.apache.pdfbox.multipdf.Overlay
Calculate the transform to be used when positioning the overlay.
CALGRAY - Static variable in class org.apache.pdfbox.cos.COSName
 
CALRGB - Static variable in class org.apache.pdfbox.cos.COSName
 
canAssembleDocument() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
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.
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.
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.
canModify() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
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).
canPrint() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print.
canPrintFaithful() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the user can print the document in a faithful format or in a degraded format (if print is enabled).
CAP - Static variable in class org.apache.pdfbox.cos.COSName
 
CAP_HEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
CAPTION - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Caption
CATALOG - Static variable in class org.apache.pdfbox.cos.COSName
 
CCITTFactory - Class in org.apache.pdfbox.pdmodel.graphics.image
Factory for creating a PDImageXObject containing a CCITT Fax compressed TIFF image.
CCITTFAX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
CCITTFAX_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
CENTER_WINDOW - Static variable in class org.apache.pdfbox.cos.COSName
 
centerWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the center window preference.
CERT - Static variable in class org.apache.pdfbox.cos.COSName
 
CERTS - Static variable in class org.apache.pdfbox.cos.COSName
 
CF - Static variable in class org.apache.pdfbox.cos.COSName
 
CFM - Static variable in class org.apache.pdfbox.cos.COSName
 
CH - Static variable in class org.apache.pdfbox.cos.COSName
 
CHAR_CODE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
 
CHAR_NAME - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
 
CHAR_PROCS - Static variable in class org.apache.pdfbox.cos.COSName
 
CHAR_SET - Static variable in class org.apache.pdfbox.cos.COSName
 
charactersByArticle - Variable in class org.apache.pdfbox.text.PDFTextStripper
The charactersByArticle is used to extract text by article divisions.
check() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
Checks the check box.
CHECK_SUM - Static variable in class org.apache.pdfbox.cos.COSName
 
checkArrayTypesClass(List<COSBase>, Class<?>) - Method in class org.apache.pdfbox.contentstream.operator.OperatorProcessor
Check whether all operands list elements are an instance of a specific class.
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
checkPages(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.COSParser
Check if all entries of the pages dictionary are present.
children() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
 
CI - Static variable in class org.apache.pdfbox.cos.COSName
 
CICI_SIGNIT - Static variable in class org.apache.pdfbox.cos.COSName
 
CID_FONT_TYPE0 - Static variable in class org.apache.pdfbox.cos.COSName
 
CID_FONT_TYPE2 - Static variable in class org.apache.pdfbox.cos.COSName
 
CID_SET - Static variable in class org.apache.pdfbox.cos.COSName
 
CID_TO_GID_MAP - Static variable in class org.apache.pdfbox.cos.COSName
 
CIDFontMapping - Class in org.apache.pdfbox.pdmodel.font
A CIDFontMapping is a kind of FontMapping which allows for an additional TrueTypeFont substitute to be provided if a CID font is not available.
CIDFontMapping(OpenTypeFont, FontBoxFont, boolean) - Constructor for class org.apache.pdfbox.pdmodel.font.CIDFontMapping
 
CIDSYSTEMINFO - Static variable in class org.apache.pdfbox.cos.COSName
 
CIDSystemInfo - Class in org.apache.pdfbox.pdmodel.font
Represents a CIDSystemInfo for the FontMapper API.
CIDSystemInfo(String, String, int) - Constructor for class org.apache.pdfbox.pdmodel.font.CIDSystemInfo
 
CL - Static variable in class org.apache.pdfbox.cos.COSName
 
CLASS_MAP - Static variable in class org.apache.pdfbox.cos.COSName
 
clear() - Method in class org.apache.pdfbox.cos.COSArray
This will remove all of the objects in the collection.
clear() - Method in class org.apache.pdfbox.cos.COSDictionary
This will clear all items in the map.
clear() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
clear() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
clear() - Method in class org.apache.pdfbox.util.SmallMap
 
CLEAR_TABLE - Static variable in class org.apache.pdfbox.filter.LZWFilter
The LZW clear table code.
clearResources() - Static method in class org.apache.pdfbox.cos.COSName
Deprecated.
will be removed in 4.0.0
clip(int) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Modify the current clipping path by intersecting it with the current path.
clip(int) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
CLIP_EVEN_ODD - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CLIP_NON_ZERO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
ClipEvenOddRule - Class in org.apache.pdfbox.contentstream.operator.graphics
W* Set clipping path using even odd rule.
ClipEvenOddRule(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.ClipEvenOddRule
 
ClipNonZeroRule - Class in org.apache.pdfbox.contentstream.operator.graphics
W Set the clipping path using non zero winding rule.
ClipNonZeroRule(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.ClipNonZeroRule
 
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.pdmodel.graphics.state.PDGraphicsState
 
clone() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
 
clone() - Method in class org.apache.pdfbox.util.Matrix
Clones this object.
cloneForNewDocument(TCOSBase) - Method in class org.apache.pdfbox.multipdf.PDFCloneUtility
Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter.
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.COSOutputStream
 
close() - Method in class org.apache.pdfbox.cos.COSStream
Called by PDFBox when the PDDocument is closed, this closes the stream and removes the data.
close() - Method in class org.apache.pdfbox.multipdf.Overlay
Close all input documents which were used for the overlay and opened by this class.
close() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
Close the underlying resource.
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.interactive.digitalsignature.SigningSupport
 
close() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will close the underlying COSDocument object.
CLOSE_AND_STROKE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CLOSE_FILL_EVEN_ODD_AND_STROKE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CLOSE_FILL_NON_ZERO_AND_STROKE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CLOSE_PATH - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CloseAndStrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
s: close and stroke the path.
CloseAndStrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CloseAndStrokePath
 
CloseFillEvenOddAndStrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
b* Close, fill and stroke the path with even-odd winding rule.
CloseFillEvenOddAndStrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CloseFillEvenOddAndStrokePath
 
CloseFillNonZeroAndStrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
b Close, fill and stroke the path with non-zero winding rule.
CloseFillNonZeroAndStrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CloseFillNonZeroAndStrokePath
 
closeNode() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
 
closeNode() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
Close this node.
ClosePath - Class in org.apache.pdfbox.contentstream.operator.graphics
h Close the path.
ClosePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.ClosePath
 
closePath() - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Closes the current path.
closePath() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
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
 
CLR_FF - Static variable in class org.apache.pdfbox.cos.COSName
 
CMAP - Static variable in class org.apache.pdfbox.cos.COSName
 
CMAPNAME - Static variable in class org.apache.pdfbox.cos.COSName
 
CMYK - Static variable in class org.apache.pdfbox.cos.COSName
 
CO - Static variable in class org.apache.pdfbox.cos.COSName
 
CODE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Code
codePointToName(int) - Method in class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Returns the name for the given Unicode code point.
codeToCID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Returns the CID for the given character code.
codeToCID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
Returns the CID for the given character code.
codeToCID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
codeToCID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the CID for the given character code.
codeToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Returns the GID for the given character code.
codeToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
codeToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
Returns the GID for the given character code.
codeToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Returns the GID for the given character code.
codeToGID(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the GID for the given character code.
codeToName - Variable in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
code-to-name map.
codeToName(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
codeToName(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
COL_SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
COLLECTION - Static variable in class org.apache.pdfbox.cos.COSName
 
COLLECTION_FIELD - Static variable in class org.apache.pdfbox.cos.COSName
 
COLLECTION_ITEM - Static variable in class org.apache.pdfbox.cos.COSName
 
COLLECTION_SCHEMA - Static variable in class org.apache.pdfbox.cos.COSName
 
COLLECTION_SORT - Static variable in class org.apache.pdfbox.cos.COSName
 
COLLECTION_SUBITEM - Static variable in class org.apache.pdfbox.cos.COSName
 
COLOR - Static variable in class org.apache.pdfbox.cos.COSName
 
COLOR - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
COLOR_BURN - Static variable in class org.apache.pdfbox.cos.COSName
 
COLOR_BURN - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
COLOR_DODGE - Static variable in class org.apache.pdfbox.cos.COSName
 
COLOR_DODGE - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
COLORANTS - Static variable in class org.apache.pdfbox.cos.COSName
 
COLORS - Static variable in class org.apache.pdfbox.cos.COSName
 
COLORSPACE - Static variable in class org.apache.pdfbox.cos.COSName
 
COLUMNS - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
compare(TextPosition, TextPosition) - Method in class org.apache.pdfbox.text.TextPositionComparator
 
compareTo(COSName) - Method in class org.apache.pdfbox.cos.COSName
 
compareTo(COSObjectKey) - Method in class org.apache.pdfbox.cos.COSObjectKey
 
compareTo(XReferenceEntry) - Method in class org.apache.pdfbox.pdfparser.xref.AbstractXReference
Compares this object with the specified object for order.
COMPATIBLE - Static variable in class org.apache.pdfbox.cos.COSName
 
COMPATIBLE - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
COMPONENTS - Static variable in class org.apache.pdfbox.cos.COSName
 
CompressParameters - Class in org.apache.pdfbox.pdfwriter.compress
An instance of this class centralizes and provides the configuration for a PDF compression.
CompressParameters() - Constructor for class org.apache.pdfbox.pdfwriter.compress.CompressParameters
 
CompressParameters(int) - Constructor for class org.apache.pdfbox.pdfwriter.compress.CompressParameters
Sets the number of objects, that can be contained in compressed object streams.
computeEncryptedKey(byte[], byte[], byte[], byte[], byte[], int, byte[], int, int, boolean, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Compute the encryption key.
computeInternalHash(long, int) - Static method in class org.apache.pdfbox.cos.COSObjectKey
Calculate the internal hash value for the given object number and generation number.
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, boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
This will compute the user password hash.
computeVersionNumber() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Computes the version number of the SecurityHandler based on the encryption key length.
CONCAT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
Concatenate - Class in org.apache.pdfbox.contentstream.operator.state
cm: Concatenate matrix to current transformation matrix.
Concatenate(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.Concatenate
 
concatenate(Matrix) - Method in class org.apache.pdfbox.util.Matrix
Concatenates (premultiplies) the given matrix to this matrix.
concatenate(Matrix, Matrix) - Static method in class org.apache.pdfbox.util.Matrix
Produces a copy of the first matrix, with the second matrix concatenated.
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Create the appearance entry for this annotation.
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Create the appearance entry for this annotation.
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSound
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSound
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
 
constructAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline
 
constructAppearances(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline
 
CONTACT_INFO - Static variable in class org.apache.pdfbox.cos.COSName
 
contains(COSBase) - Method in class org.apache.pdfbox.cos.COSIncrement
Returns true, if the given COSBase is already known to and has been processed by this COSIncrement.
contains(COSObjectKey) - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Returns true, if a COSBase is registered for the given COSObjectKey.
contains(COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Returns true, if the given COSBase is a registered object of this pool.
contains(COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns true, if the given COSBase is a registered object of this compression pool.
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(String) - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
Determines if the encoding has a mapping for the given name value.
contains(int) - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
Determines if the encoding has a mapping for the given code value.
contains(TextPosition) - Method in class org.apache.pdfbox.text.TextPosition
Determine if this TextPosition logically contains another (i.e.
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
containsKey(Object) - Method in class org.apache.pdfbox.util.SmallMap
 
containsName(String) - Static method in class org.apache.pdfbox.pdmodel.font.Standard14Fonts
Returns true if the given font name is one of the known names, including alias.
containsValue(Object) - Method in class org.apache.pdfbox.cos.COSDictionary
 
containsValue(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
containsValue(Object) - Method in class org.apache.pdfbox.util.SmallMap
 
CONTENTS - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
convert(Map<String, ?>) - 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.
convertBasicTypesToMap(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
This will take a COS dictionary and convert it into COSDictionaryMap.
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 number tree to the PD Model object.
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
 
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
 
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
 
convertCOSToPD(COSBase) - Method in class org.apache.pdfbox.pdmodel.PDStructureElementNameTreeNode
 
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.
convXYZtoRGB(float, float, float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
coordinates(float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
COORDS - Static variable in class org.apache.pdfbox.cos.COSName
 
copyIntoGraphicsState(PDGraphicsState) - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.
COSArray(List<? extends COSObjectable>) - Constructor for class org.apache.pdfbox.cos.COSArray
Use the given list to initialize the COSArray.
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
Create the COSArrayList specifying the List and the backing COSArray.
COSArrayList(COSDictionary, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
This constructor is to be used if the array doesn't exist, but is to be created and added to the parent dictionary as soon as the first element is added to the array.
COSArrayList(E, COSBase, COSDictionary, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.COSArrayList
This is a really special constructor.
COSBase - Class in org.apache.pdfbox.cos
The base object that all objects in the PDF document will extend.
COSBase() - Constructor for class org.apache.pdfbox.cos.COSBase
Constructor.
COSBoolean - Class in org.apache.pdfbox.cos
This class represents a boolean value in the PDF document.
COSDictionary - Class in org.apache.pdfbox.cos
This class represents a dictionary where name/value pairs reside.
COSDictionary() - Constructor for class org.apache.pdfbox.cos.COSDictionary
Constructor.
COSDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.cos.COSDictionary
Copy Constructor.
COSDictionaryMap<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() - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor.
COSDocument(ICOSParser) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor.
COSDocument(RandomAccessStreamCache.StreamCacheCreateFunction) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will use the provided function to create a stream cache for the storage of the PDF streams.
COSDocument(RandomAccessStreamCache.StreamCacheCreateFunction, ICOSParser) - Constructor for class org.apache.pdfbox.cos.COSDocument
Constructor that will use the provided function to create a stream cache for the storage of the PDF streams.
COSDocumentState - Class in org.apache.pdfbox.cos
An instance of COSDocumentState collects all known states a COSDocument may have and shall allow their evaluation.
COSDocumentState() - Constructor for class org.apache.pdfbox.cos.COSDocumentState
 
COSFilterInputStream - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
A filtered stream that includes the bytes that are in the (begin,length) intervals passed in the constructor.
COSFilterInputStream(InputStream, int[]) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.COSFilterInputStream
 
COSFilterInputStream(byte[], int[]) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.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.
COSIncrement - Class in org.apache.pdfbox.cos
A COSIncrement starts at a given COSUpdateInfo to collect updates, that have been made to a COSDocument and therefore should be added to it´s next increment.
COSIncrement(COSUpdateInfo) - Constructor for class org.apache.pdfbox.cos.COSIncrement
Creates a new COSIncrement for the given COSUpdateInfo, the increment will use it´s COSDocumentState as it´s own origin and shall collect all updates contained in the given COSUpdateInfo.
Should the given object be null, the resulting increment shall be empty.
COSInputStream - Class in org.apache.pdfbox.cos
An InputStream which reads from an encoded COS stream.
COSInteger - Class in org.apache.pdfbox.cos
This class represents an integer number in a PDF document.
COSName - Class in org.apache.pdfbox.cos
A PDF Name 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.
COSObject(COSBase, COSObjectKey) - Constructor for class org.apache.pdfbox.cos.COSObject
Constructor.
COSObject(COSBase, ICOSParser) - Constructor for class org.apache.pdfbox.cos.COSObject
Constructor.
COSObject(COSObjectKey, ICOSParser) - 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.cos
Object representing the physical reference to an indirect pdf object.
COSObjectKey(long, int) - Constructor for class org.apache.pdfbox.cos.COSObjectKey
Constructor.
COSObjectKey(long, int, int) - Constructor for class org.apache.pdfbox.cos.COSObjectKey
Constructor.
COSObjectPool - Class in org.apache.pdfbox.pdfwriter.compress
An instance of this class maps COSBase instances to COSObjectKeys and allows for a bidirectional lookup.
COSObjectPool(long) - Constructor for class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Creates a map of COSBase instances to COSObjectKeys, allowing bidirectional lookups.
COSOutputStream - Class in org.apache.pdfbox.cos
An OutputStream which writes to an encoded COS stream.
COSParser - Class in org.apache.pdfbox.pdfparser
COS-Parser which first reads startxref and xref tables in order to know valid objects and parse only these objects.
COSParser(RandomAccessRead) - Constructor for class org.apache.pdfbox.pdfparser.COSParser
Default constructor.
COSParser(RandomAccessRead, String, InputStream, String) - Constructor for class org.apache.pdfbox.pdfparser.COSParser
Constructor for encrypted pdfs.
COSParser(RandomAccessRead, String, InputStream, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Constructor for class org.apache.pdfbox.pdfparser.COSParser
Constructor for encrypted pdfs.
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
Constructor.
COSStandardOutputStream(OutputStream, long) - Constructor for class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
Constructor.
COSStream - Class in org.apache.pdfbox.cos
This class represents a stream object in a PDF document.
COSStream() - Constructor for class org.apache.pdfbox.cos.COSStream
Creates a new stream with an empty dictionary.
COSStream(RandomAccessStreamCache) - Constructor for class org.apache.pdfbox.cos.COSStream
Creates a new stream with an empty dictionary.
COSStream(RandomAccessStreamCache, RandomAccessReadView) - Constructor for class org.apache.pdfbox.cos.COSStream
Creates a new stream with an empty dictionary.
COSString - Class in org.apache.pdfbox.cos
A string object, which may be a text string, a PDFDocEncoded string, ASCII string, or byte string.
COSString(byte[]) - Constructor for class org.apache.pdfbox.cos.COSString
Creates a new PDF string from a byte array.
COSString(String) - Constructor for class org.apache.pdfbox.cos.COSString
Creates a new text string from a Java String.
COSUpdateInfo - Interface in org.apache.pdfbox.cos
 
COSUpdateState - Class in org.apache.pdfbox.cos
A COSUpdateState instance manages update states for a COSUpdateInfo.
COSUpdateState(COSUpdateInfo) - Constructor for class org.apache.pdfbox.cos.COSUpdateState
Creates a new COSUpdateState for the given COSUpdateInfo.
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.
COSWriter(OutputStream, CompressParameters) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
COSWriter constructor.
COSWriter(OutputStream, RandomAccessRead) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
COSWriter constructor for incremental updates.
COSWriter(OutputStream, RandomAccessRead, Set<COSDictionary>) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
Constructor for incremental updates with a list of objects to write.
COSWriterCompressionPool - Class in org.apache.pdfbox.pdfwriter.compress
An instance of this class compresses the contents of a given PDDocument.
COSWriterCompressionPool(PDDocument, CompressParameters) - Constructor for class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Constructs an object that can be used to compress the contents of a given PDDocument.
COSWriterObjectStream - Class in org.apache.pdfbox.pdfwriter.compress
An instance of this class represents an object stream, that compresses a number of COSObjects in a stream.
COSWriterObjectStream(COSWriterCompressionPool) - Constructor for class org.apache.pdfbox.pdfwriter.compress.COSWriterObjectStream
Creates an object stream for compressible objects from the given COSWriterCompressionPool.
COUNT - Static variable in class org.apache.pdfbox.cos.COSName
 
CP - Static variable in class org.apache.pdfbox.cos.COSName
 
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.documentinterchange.markedcontent.PDPropertyList
Creates a property list from the given dictionary.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Create the correct FDFAnnotation.
create(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Creates a color space given a name or array.
create(COSBase, PDResources) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Creates a color space given a name or array.
create(COSBase, PDResources, boolean) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Creates a color space given a name or array.
create(COSArray, PDResources) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Creates a new ICC color space using the PDF array, optionally using a resource cache.
create(COSDictionary, ResourceCache) - Static method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Create the correct PD Model pattern based on the COS base pattern.
create(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Create the correct PD Model shading based on the COS base shading.
create(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Creates a new soft mask.
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(AffineTransform) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
In order to create Affine Transform, using parameters.
createAffineTransform(AffineTransform) - 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(PDFormXObject, PDSignatureField) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates appearance dictionary
createAppearanceDictionary(PDFormXObject, PDSignatureField) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createBackgroundLayerForm(PDResources, PDRectangle) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates the background layer form (n0).
createBackgroundLayerForm(PDResources, PDRectangle) - 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
 
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
 
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
 
createChildNode(COSDictionary) - Method in class org.apache.pdfbox.pdmodel.PDStructureElementNameTreeNode
 
createContext(ColorModel, ColorModel, RenderingHints) - Method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendComposite
 
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
 
createCOSStream() - Method in class org.apache.pdfbox.cos.COSDocument
Creates a new COSStream using the current configuration for scratch files.
createCOSStream(COSDictionary, long, long) - Method in class org.apache.pdfbox.cos.COSDocument
Creates a new COSStream using the current configuration for scratch files.
createCOSStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
 
createDefault() - Static method in class org.apache.pdfbox.filter.DecodeResult
Return a default DecodeResult.
createDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
Create the resulting document.
createField(PDAcroForm, COSDictionary, PDNonTerminalField) - Static method in class org.apache.pdfbox.pdmodel.interactive.form.PDFieldFactory
Creates a COSField subclass from the given field.
createFont(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.font.PDFontFactory
Creates a new PDFont instance with the appropriate subclass.
createFont(COSDictionary, ResourceCache) - Static method in class org.apache.pdfbox.pdmodel.font.PDFontFactory
Creates a new PDFont instance with the appropriate subclass.
createFormatterRectangle(int[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
An array of four numbers in the form coordinate system, giving the coordinates of the left, bottom, right, and top edges, respectively, of the form XObject’s bounding box.
createFormatterRectangle(int[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createFromByteArray(PDDocument, byte[]) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory
Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.
createFromByteArray(PDDocument, byte[], int) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory
Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.
createFromByteArray(PDDocument, byte[]) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory
Creates a new JPEG Image XObject from a byte array containing JPEG data.
createFromByteArray(PDDocument, byte[], String) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Create a PDImageXObject from bytes of an image file.
createFromFile(PDDocument, File) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory
Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file.
createFromFile(PDDocument, File, int) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory
Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file.
createFromFile(String, PDDocument) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Create a PDImageXObject from an image file, see PDImageXObject.createFromFileByExtension(File, PDDocument) for more details.
createFromFileByContent(File, PDDocument) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Create a PDImageXObject from an image file.
createFromFileByExtension(File, PDDocument) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Create a PDImageXObject from an image file.
createFromImage(PDDocument, BufferedImage) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory
Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage.
createFromImage(PDDocument, BufferedImage) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory
Creates a new JPEG PDImageXObject from a BufferedImage.
createFromImage(PDDocument, BufferedImage, float) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory
Creates a new JPEG PDImageXObject from a BufferedImage and a given quality.
createFromImage(PDDocument, BufferedImage, float, int) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory
Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata.
createFromImage(PDDocument, BufferedImage) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.LosslessFactory
Creates a new lossless encoded image XObject from a BufferedImage.
createFromStream(PDDocument, InputStream) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory
Creates a new JPEG Image XObject from an input stream containing JPEG data.
createFS(COSBase) - Static method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
A file specification 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
Create a holder for the form stream.
createHolderFormStream(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createImageForm(PDResources, PDResources, PDStream, PDRectangle, AffineTransform, PDImageXObject) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates Image form
createImageForm(PDResources, PDResources, PDStream, PDRectangle, AffineTransform, PDImageXObject) - 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
Create image form stream.
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
Creates InnerForm.
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
Create a holder for the inner form stream.
createInnerFormStream(PDDocument) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createInputStream() - Method in class org.apache.pdfbox.cos.COSStream
Returns a new InputStream which reads the decoded stream data.
createInputStream(DecodeOptions) - Method in class org.apache.pdfbox.cos.COSStream
 
createInputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream that can be read from.
createInputStream(DecodeOptions) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
 
createInputStream(List<String>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream with some filters applied but not others.
createInputStream() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns an InputStream containing the image data, irrespective of whether this is an inline image or an image XObject.
createInputStream(List<String>) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns an InputStream containing the image data, irrespective of whether this is an inline image or an image XObject.
createInputStream(DecodeOptions) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns an InputStream, passing additional options to each filter.
createInputStream() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
createInputStream(DecodeOptions) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
createInputStream(List<String>) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
createInputStream() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
createInputStream(DecodeOptions) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
createInputStream(List<String>) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
createMatrix(COSBase) - Static method in class org.apache.pdfbox.util.Matrix
Convenience method to be used when creating a matrix from unverified data.
createNewDocument() - Method in class org.apache.pdfbox.multipdf.Splitter
Create a new document to write the split contents to.
createObject(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Creates an object for a kid of this structure node.
createObjectStreams() - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Creates COSWriterObjectStreams for all currently registered objects of this pool, that have been marked as fit for being compressed in this manner.
createOutputStream() - Method in class org.apache.pdfbox.cos.COSStream
Returns a new OutputStream for writing stream data, using the current filters.
createOutputStream(COSBase) - Method in class org.apache.pdfbox.cos.COSStream
Returns a new OutputStream for writing stream data, using and the given filters.
createOutputStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream that can be written to.
createOutputStream(COSName) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will get a stream that can be written to, with the given filter.
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
 
createPageDrawer(PageDrawerParameters) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns a new PageDrawer instance, using the given parameters.
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
 
createRandomAccessReadView(long, long) - Method in interface org.apache.pdfbox.cos.ICOSParser
Creates a random access read view starting at the given position with the given length.
createRandomAccessReadView(long, long) - Method in class org.apache.pdfbox.pdfparser.COSParser
 
createRawInputStream() - Method in class org.apache.pdfbox.cos.COSStream
Returns a new InputStream which reads the encoded PDF stream data.
createRawOutputStream() - Method in class org.apache.pdfbox.cos.COSStream
Returns a new OutputStream for writing encoded PDF data.
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 the signature with the given name and assign it to the signature field parameter and assign the page parameter to the widget.
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, BufferedImage) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Creates signature image.
createSignatureImage(PDDocument, BufferedImage) - 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 SignatureRectangle.
createSignatureRectangle(PDSignatureField, PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
createStream(PDDocument) - Static method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
This will create a new PDObjectStream 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
Creates a PDDocument and adds the page parameter to it and keeps this as a template in the PDF template Structure.
createThumbnail(COSStream) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Creates a thumbnail Image XObject from the given COSBase and name.
createView() - Method in class org.apache.pdfbox.cos.COSStream
Returns a new RandomAccessRead which reads the decoded stream data.
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, PDResources) - Static method in class org.apache.pdfbox.pdmodel.graphics.PDXObject
Creates a new XObject instance of the appropriate type for the COS stream.
CREATION_DATE - Static variable in class org.apache.pdfbox.cos.COSName
 
CREATOR - Static variable in class org.apache.pdfbox.cos.COSName
 
CRL - Static variable in class org.apache.pdfbox.cos.COSName
 
CRLF - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
To be used when 2 byte sequence is enforced.
CRLS - Static variable in class org.apache.pdfbox.cos.COSName
 
CROP_BOX - Static variable in class org.apache.pdfbox.cos.COSName
 
CRYPT - Static variable in class org.apache.pdfbox.cos.COSName
 
cryptFilterDictionary - Variable in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
COS crypt filter dictionary.
CS - Static variable in class org.apache.pdfbox.cos.COSName
 
CURVE_TO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CURVE_TO_REPLICATE_FINAL_POINT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CURVE_TO_REPLICATE_INITIAL_POINT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
CurveTo - Class in org.apache.pdfbox.contentstream.operator.graphics
c Append curved segment to path.
CurveTo(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CurveTo
 
curveTo(float, float, float, float, float, float) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Draws a curve from the current point to (x3,y3) using (x1,y1) and (x2,y2) as control points.
curveTo(float, float, float, float, float, float) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
CurveToReplicateFinalPoint - Class in org.apache.pdfbox.contentstream.operator.graphics
y Append curved segment to path with final point replicated.
CurveToReplicateFinalPoint(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateFinalPoint
 
CurveToReplicateInitialPoint - Class in org.apache.pdfbox.contentstream.operator.graphics
v Append curved segment to path with the initial point replicated.
CurveToReplicateInitialPoint(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateInitialPoint
 
CYX - Static variable in class org.apache.pdfbox.cos.COSName
 

D

D - Static variable in class org.apache.pdfbox.cos.COSName
 
D - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
DA - Static variable in class org.apache.pdfbox.cos.COSName
 
DARKEN - Static variable in class org.apache.pdfbox.cos.COSName
 
DARKEN - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
DATE - Static variable in class org.apache.pdfbox.cos.COSName
 
DateConverter - Class in org.apache.pdfbox.util
Converts 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
 
DCT_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.Filter
Decodes data, producing the original non-encoded data.
decode(InputStream, OutputStream, COSDictionary, int, DecodeOptions) - Method in class org.apache.pdfbox.filter.Filter
Decodes data, with optional DecodeOptions.
decode(InputStream, List<Filter>, COSDictionary, DecodeOptions, List<DecodeResult>) - Static method in class org.apache.pdfbox.filter.Filter
Decodes data, with optional DecodeOptions.
decode(InputStream, OutputStream, COSDictionary, int, DecodeOptions) - Method in class org.apache.pdfbox.filter.JPXFilter
Decodes data, with optional DecodeOptions.
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.JPXFilter
 
decode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.LZWFilter
Decodes data, producing the original non-encoded data.
DECODE_PARMS - Static variable in class org.apache.pdfbox.cos.COSName
 
decodeBase64(String) - Static method in class org.apache.pdfbox.util.Hex
Decode a base64 String.
decodeHex(String) - Static method in class org.apache.pdfbox.util.Hex
Decodes a hex String into a byte array.
DecodeOptions - Class in org.apache.pdfbox.filter
Options that may be passed to a Filter to request special handling when decoding the stream.
DecodeOptions() - Constructor for class org.apache.pdfbox.filter.DecodeOptions
Constructs an empty DecodeOptions instance
DecodeOptions(Rectangle) - Constructor for class org.apache.pdfbox.filter.DecodeOptions
Constructs an instance specifying the region of the image that should be decoded.
DecodeOptions(int, int, int, int) - Constructor for class org.apache.pdfbox.filter.DecodeOptions
Constructs an instance specifying the region of the image that should be decoded.
DecodeOptions(int) - Constructor for class org.apache.pdfbox.filter.DecodeOptions
Constructs an instance specifying the image should be decoded using subsampling.
DecodeResult - Class in org.apache.pdfbox.filter
The result of a filter decode operation.
decreaseLevel() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Decrease the level.
decrypt(COSBase, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will dispatch to the correct method.
DecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
This class represents data required to decrypt PDF documents.
DecryptionMaterial() - Constructor for class org.apache.pdfbox.pdmodel.encryption.DecryptionMaterial
 
decryptStream(COSStream, long, long) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will decrypt a stream.
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
 
DEFAULT - Static variable in class org.apache.pdfbox.filter.DecodeOptions
Default decode options.
DEFAULT_CMYK - Static variable in class org.apache.pdfbox.cos.COSName
 
DEFAULT_COMPRESSION - Static variable in class org.apache.pdfbox.pdfwriter.compress.CompressParameters
 
DEFAULT_CRYPT_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
 
DEFAULT_FONT_MATRIX - Static variable in class org.apache.pdfbox.pdmodel.font.PDFont
 
DEFAULT_GRAY - Static variable in class org.apache.pdfbox.cos.COSName
 
DEFAULT_LENGTH - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
The default length for the encryption key.
DEFAULT_NAME - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
The default security handler.
DEFAULT_OBJECT_STREAM_SIZE - Static variable in class org.apache.pdfbox.pdfwriter.compress.CompressParameters
 
DEFAULT_RGB - Static variable in class org.apache.pdfbox.cos.COSName
 
DEFAULT_SIGNATURE_SIZE - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
 
DEFAULT_VERSION - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
The default version, according to the PDF Reference.
DefaultResourceCache - Class in org.apache.pdfbox.pdmodel
A resource cached based on SoftReference, retains resources until memory pressure causes them to be garbage collected.
DefaultResourceCache() - Constructor for class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
dereferenceCOSObject(COSObject) - Method in interface org.apache.pdfbox.cos.ICOSParser
Dereference the COSBase object which is referenced by the given COSObject.
dereferenceCOSObject(COSObject) - Method in class org.apache.pdfbox.pdfparser.COSParser
 
DESC - Static variable in class org.apache.pdfbox.cos.COSName
 
DESCENDANT_FONTS - Static variable in class org.apache.pdfbox.cos.COSName
 
DESCENT - Static variable in class org.apache.pdfbox.cos.COSName
 
DEST - Static variable in class org.apache.pdfbox.cos.COSName
 
DEST_OUTPUT_PROFILE - Static variable in class org.apache.pdfbox.cos.COSName
 
DESTS - Static variable in class org.apache.pdfbox.cos.COSName
 
detectFileType(BufferedInputStream) - Static method in class org.apache.pdfbox.util.filetypedetector.FileTypeDetector
Examines the a file's first bytes and estimates the file's type.
detectFileType(byte[]) - Static method in class org.apache.pdfbox.util.filetypedetector.FileTypeDetector
 
DEVICECMYK - Static variable in class org.apache.pdfbox.cos.COSName
 
DEVICEGRAY - Static variable in class org.apache.pdfbox.cos.COSName
 
DEVICEN - Static variable in class org.apache.pdfbox.cos.COSName
 
DEVICERGB - Static variable in class org.apache.pdfbox.cos.COSName
 
DI - Static variable in class org.apache.pdfbox.cos.COSName
 
dict - Variable in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
 
dict - Variable in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
dict - Variable in class org.apache.pdfbox.pdmodel.font.PDFont
 
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.
dictionary - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
DictionaryEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This will perform the encoding from a dictionary.
DictionaryEncoding(COSName, COSArray) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
Creates a new DictionaryEncoding for embedding.
DictionaryEncoding(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
Creates a new DictionaryEncoding for a Type 3 font from a PDF.
DictionaryEncoding(COSDictionary, boolean, Encoding) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
Creates a new DictionaryEncoding from a PDF.
DIFFERENCE - Static variable in class org.apache.pdfbox.cos.COSName
 
DIFFERENCE - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
DIFFERENCES - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_METHOD - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_RIPEMD160 - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_SHA1 - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_SHA256 - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_SHA384 - Static variable in class org.apache.pdfbox.cos.COSName
 
DIGEST_SHA512 - Static variable in class org.apache.pdfbox.cos.COSName
 
DIRECTION - Static variable in class org.apache.pdfbox.cos.COSName
 
DISPLAY_DOC_TITLE - Static variable in class org.apache.pdfbox.cos.COSName
 
displayDocTitle() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Get the display doc title preference.
dispose() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
 
dispose() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
 
dispose() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
DIV - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Div
DL - Static variable in class org.apache.pdfbox.cos.COSName
 
DM - Static variable in class org.apache.pdfbox.cos.COSName
 
DOC - Static variable in class org.apache.pdfbox.cos.COSName
 
DOC_CHECKSUM - Static variable in class org.apache.pdfbox.cos.COSName
 
DOC_TIME_STAMP - Static variable in class org.apache.pdfbox.cos.COSName
 
DOCMDP - Static variable in class org.apache.pdfbox.cos.COSName
 
DOCUMENT - Static variable in class org.apache.pdfbox.cos.COSName
 
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.fixup.AbstractFixup
 
document - Variable in class org.apache.pdfbox.pdmodel.fixup.processor.AbstractProcessor
 
document - Variable in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
 
document - Variable in class org.apache.pdfbox.rendering.PDFRenderer
 
document - Variable in class org.apache.pdfbox.text.PDFTextStripper
 
DOMAIN - Static variable in class org.apache.pdfbox.cos.COSName
 
doNotScroll() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
doNotSpellCheck() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
DOS - Static variable in class org.apache.pdfbox.cos.COSName
 
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(COSObjectKey, COSBase) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write a COS object for a predefined key.
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.
DP - Static variable in class org.apache.pdfbox.cos.COSName
 
DR - Static variable in class org.apache.pdfbox.cos.COSName
 
DRAW_OBJECT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
drawImage(PDImage) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Draw the image.
drawImage(PDImage) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
DrawObject - Class in org.apache.pdfbox.contentstream.operator
Do: Draws an XObject.
DrawObject(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.DrawObject
 
DrawObject - Class in org.apache.pdfbox.contentstream.operator.graphics
Do: Draws an XObject.
DrawObject(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.DrawObject
 
DrawObject - Class in org.apache.pdfbox.contentstream.operator.markedcontent
Do: Draws an XObject.
DrawObject(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.markedcontent.DrawObject
 
drawPage(Graphics2D, PDRectangle) - Method in class org.apache.pdfbox.rendering.PageDrawer
Draws the page to the requested context.
drawShape(float, boolean, boolean) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Draw a shape.
DS - Static variable in class org.apache.pdfbox.cos.COSName
 
DSS - Static variable in class org.apache.pdfbox.cos.COSName
 
DUPLEX - Static variable in class org.apache.pdfbox.cos.COSName
 
DUR - Static variable in class org.apache.pdfbox.cos.COSName
 
DV - Static variable in class org.apache.pdfbox.cos.COSName
 
DW - Static variable in class org.apache.pdfbox.cos.COSName
 
DW2 - Static variable in class org.apache.pdfbox.cos.COSName
 

E

E - Static variable in class org.apache.pdfbox.cos.COSName
 
E - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
EARLY_CHANGE - Static variable in class org.apache.pdfbox.cos.COSName
 
EF - Static variable in class org.apache.pdfbox.cos.COSName
 
EMBEDDED_FDFS - Static variable in class org.apache.pdfbox.cos.COSName
 
EMBEDDED_FILE - Static variable in class org.apache.pdfbox.cos.COSName
 
EMBEDDED_FILES - Static variable in class org.apache.pdfbox.cos.COSName
 
EMPTY - Static variable in class org.apache.pdfbox.cos.COSName
 
EmptyGraphicsStackException - Exception in org.apache.pdfbox.contentstream.operator.state
Throw when restore is executed when the graphics stack is empty.
ENCODE - Static variable in class org.apache.pdfbox.cos.COSName
 
encode(InputStream, OutputStream, COSDictionary, int) - Method in class org.apache.pdfbox.filter.Filter
Encodes data.
encode(InputStream, OutputStream, COSDictionary) - Method in class org.apache.pdfbox.filter.Filter
 
encode(InputStream, OutputStream, COSDictionary) - Method in class org.apache.pdfbox.filter.JPXFilter
encode(InputStream, OutputStream, COSDictionary) - Method in class org.apache.pdfbox.filter.LZWFilter
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Encodes the given Unicode code point for use in a PDF content stream.
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
encode(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Encodes the given string for use in a PDF content stream.
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Encodes the given Unicode code point for use in a PDF content stream.
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
encode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
ENCODED_BYTE_ALIGN - Static variable in class org.apache.pdfbox.cos.COSName
 
encodeGlyphId(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
encodeGlyphId(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
encodeGlyphId(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
encodeGlyphId(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the encoded value for the given glyph ID.
ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
Encoding - Class in org.apache.pdfbox.pdmodel.font.encoding
A PostScript encoding vector, maps character codes to glyph names.
Encoding() - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.Encoding
 
encoding - Variable in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
ENCODING_90MS_RKSJ_H - Static variable in class org.apache.pdfbox.cos.COSName
 
ENCODING_90MS_RKSJ_V - Static variable in class org.apache.pdfbox.cos.COSName
 
ENCODING_ETEN_B5_H - Static variable in class org.apache.pdfbox.cos.COSName
 
ENCODING_ETEN_B5_V - Static variable in class org.apache.pdfbox.cos.COSName
 
ENCRYPT - Static variable in class org.apache.pdfbox.cos.COSName
 
ENCRYPT_META_DATA - Static variable in class org.apache.pdfbox.cos.COSName
 
encryptDataRC4(byte[], InputStream, OutputStream) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Encrypt or decrypt data with RC4.
encryptDataRC4(byte[], byte[], OutputStream) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Encrypt or decrypt data with RC4.
ENCRYPTED_PAYLOAD - Static variable in class org.apache.pdfbox.cos.COSName
 
encryptStream(COSStream, long, int) - 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, int) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
This will encrypt a string.
END_COMPATIBILITY_SECTION - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
END_INLINE_IMAGE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
END_MARKED_CONTENT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
END_OF_LINE - Static variable in class org.apache.pdfbox.cos.COSName
 
END_TEXT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
endArticle() - Method in class org.apache.pdfbox.text.PDFTextStripper
End an article.
endDocument(PDDocument) - Method in class org.apache.pdfbox.text.PDFTextStripper
This method is available for subclasses of this class.
EndMarkedContentSequence - Class in org.apache.pdfbox.contentstream.operator.markedcontent
EMC : Ends a marked-content sequence begun by BMC or BDC.
EndMarkedContentSequence(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.markedcontent.EndMarkedContentSequence
 
endMarkedContentSequence() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a marked content group ends
endMarkedContentSequence() - Method in class org.apache.pdfbox.rendering.PageDrawer
Called when a marked content group ends
endMarkedContentSequence() - Method in class org.apache.pdfbox.text.PDFMarkedContentExtractor
 
ENDOBJ - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The end object token.
ENDOBJ_STRING - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a string constant that will be used for comparisons.
endPage(PDPage) - Method in class org.apache.pdfbox.text.PDFTextStripper
End a page.
EndPath - Class in org.apache.pdfbox.contentstream.operator.graphics
n End the path.
EndPath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.EndPath
 
ENDPATH - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
endPath() - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Ends the current path without filling or stroking it.
endPath() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
ENDSTREAM - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The close stream token.
ENDSTREAM_STRING - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a string constant that will be used for comparisons.
EndText - Class in org.apache.pdfbox.contentstream.operator.text
ET: End text.
EndText(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.EndText
 
endText() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when the ET operator is encountered.
endText() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
ENTRUST_PPKEF - Static variable in class org.apache.pdfbox.cos.COSName
 
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
entrySet() - Method in class org.apache.pdfbox.util.SmallMap
 
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.COSParser
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.
equals(Object) - Method in class org.apache.pdfbox.cos.COSBoolean
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.COSObjectKey
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.documentinterchange.logicalstructure.PDUserProperty
 
equals(Object) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
equals(Object) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
equals(Object) - Method in class org.apache.pdfbox.pdmodel.PDPage
 
equals(Object) - Method in class org.apache.pdfbox.text.TextPosition
 
equals(Object) - Method in class org.apache.pdfbox.util.Matrix
 
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
Performs exponential interpolation 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.
eval(float[]) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity
 
evalFunction(float) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Convert the input value using the functions of the shading dictionary.
evalFunction(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Convert the input values using the functions of the shading dictionary.
EX_DATA - Static variable in class org.apache.pdfbox.cos.COSName
 
exclude(COSBase...) - Method in class org.apache.pdfbox.cos.COSIncrement
The given COSBases are not fit for inclusion in an increment and shall be added to COSIncrement.excluded.
null values shall be ignored.
EXCLUSION - Static variable in class org.apache.pdfbox.cos.COSName
 
EXCLUSION - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
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.
EXPORT - Static variable in class org.apache.pdfbox.cos.COSName
 
EXPORT_STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
exportFDF() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will export all FDF form data.
exportXMPMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Extract the XMP metadata.
EXT_G_STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
EXTEND - Static variable in class org.apache.pdfbox.cos.COSName
 
EXTENDS - Static variable in class org.apache.pdfbox.cos.COSName
 
EXTENSION_LEVEL - Static variable in class org.apache.pdfbox.cos.COSName
 
EXTENSIONS - Static variable in class org.apache.pdfbox.cos.COSName
 
ExternalSigningSupport - Interface in org.apache.pdfbox.pdmodel.interactive.digitalsignature
Interface for external signature creation scenarios.
extract() - Method in class org.apache.pdfbox.multipdf.PageExtractor
This will take a document and extract the desired pages into a new document.
extractRegions(PDPage) - Method in class org.apache.pdfbox.text.PDFTextStripperByArea
Process the page to extract the region text.

F

F - Static variable in class org.apache.pdfbox.cos.COSName
 
F_DECODE_PARMS - Static variable in class org.apache.pdfbox.cos.COSName
 
F_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
 
FALSE - Static variable in class org.apache.pdfbox.cos.COSBoolean
The PDF false value.
FB - Static variable in class org.apache.pdfbox.cos.COSName
 
FDF - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
FDFAnnotationLink - Class in org.apache.pdfbox.pdmodel.fdf
This represents a Polygon FDF annotation.
FDFAnnotationLink() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLink
Default constructor.
FDFAnnotationLink(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLink
Constructor.
FDFAnnotationLink(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLink
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.
FDFAnnotationTextMarkup - Class in org.apache.pdfbox.pdmodel.fdf
This abstract class is used as a superclass for the different FDF annotations with text markup attributes.
FDFAnnotationTextMarkup() - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup
Default constructor.
FDFAnnotationTextMarkup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup
Constructor.
FDFAnnotationTextMarkup(Element) - Constructor for class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup
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.
FDFParser - Class in org.apache.pdfbox.pdfparser
 
FDFParser(RandomAccessRead) - Constructor for class org.apache.pdfbox.pdfparser.FDFParser
Constructs parser for given file using memory buffer.
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
 
FIELDS - Static variable in class org.apache.pdfbox.cos.COSName
 
FieldUtils - Class in org.apache.pdfbox.pdmodel.interactive.form
A set of utility methods to help with common AcroForm form and field related functions.
Figure - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Figure
fileLen - Variable in class org.apache.pdfbox.pdfparser.COSParser
file length.
FILESPEC - Static variable in class org.apache.pdfbox.cos.COSName
 
FileType - Enum in org.apache.pdfbox.util.filetypedetector
 
FileTypeDetector - Class in org.apache.pdfbox.util.filetypedetector
 
FILL_EVEN_ODD - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
FILL_EVEN_ODD_AND_STROKE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
FILL_NON_ZERO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
FILL_NON_ZERO_AND_STROKE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
fillAndStrokePath(int) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Fills and then strokes the path.
fillAndStrokePath(int) - Method in class org.apache.pdfbox.rendering.PageDrawer
Fills and then strokes the path.
FillEvenOddAndStrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
B* Fill and then stroke the path, using the even-odd rule to determine the region to fill.
FillEvenOddAndStrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddAndStrokePath
 
FillEvenOddRule - Class in org.apache.pdfbox.contentstream.operator.graphics
f* Fill path using even odd rule.
FillEvenOddRule(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddRule
 
FillNonZeroAndStrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
B Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.
FillNonZeroAndStrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroAndStrokePath
 
FillNonZeroRule - Class in org.apache.pdfbox.contentstream.operator.graphics
f Fill path using non zero winding rule.
FillNonZeroRule(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroRule
 
fillPath(int) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Fill the path.
fillPath(int) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
FILTER - Static variable in class org.apache.pdfbox.cos.COSName
 
Filter - Class in org.apache.pdfbox.filter
A filter for stream data.
Filter() - Constructor for class org.apache.pdfbox.filter.Filter
Constructor.
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_VERISIGN_PPKVS - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
A signature filter value.
FilterFactory - Class in org.apache.pdfbox.filter
Factory for Filter classes.
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.
findImageReader(String, String) - Static method in class org.apache.pdfbox.filter.Filter
Finds a suitable image raster reader for an image format.
findNamedDestinationPage(PDNamedDestination) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Find the page destination from a named destination.
FIRST - Static variable in class org.apache.pdfbox.cos.COSName
 
FIRST_CHAR - Static variable in class org.apache.pdfbox.cos.COSName
 
FIT_WINDOW - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
FL - Static variable in class org.apache.pdfbox.cos.COSName
 
FLAG_ADD_REV_INFO - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_DIGEST_METHOD - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_FILTER - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_ISSUER - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff flag.
FLAG_KEY_USAGE - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff flag.
FLAG_LEGAL_ATTESTATION - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_OID - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff flag.
FLAG_REASON - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_SUBFILTER - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
A Ff flag.
FLAG_SUBJECT - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff flag.
FLAG_SUBJECT_DN - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff flag.
FLAG_URL - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A Ff 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
 
FLATE_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
FLATE_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
flatten() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will flatten all form fields.
flatten(List<PDField>, boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will flatten the specified form fields.
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.cos.COSOutputStream
 
FO - Static variable in class org.apache.pdfbox.cos.COSName
 
FOLDERS - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_BBOX - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_DESC - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_FAMILY - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_FILE - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_FILE2 - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_FILE3 - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_MATRIX - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_NAME - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_STRETCH - Static variable in class org.apache.pdfbox.cos.COSName
 
FONT_WEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
FontCache - Class in org.apache.pdfbox.pdmodel.font
An in-memory cache for system fonts.
FontCache() - Constructor for class org.apache.pdfbox.pdmodel.font.FontCache
 
FontFormat - Enum in org.apache.pdfbox.pdmodel.font
Font file format.
FontInfo - Class in org.apache.pdfbox.pdmodel.font
Information about a font on the system.
FontInfo() - Constructor for class org.apache.pdfbox.pdmodel.font.FontInfo
 
FontMapper - Interface in org.apache.pdfbox.pdmodel.font
Font mapper, locates non-embedded fonts.
FontMappers - Class in org.apache.pdfbox.pdmodel.font
FontMapper factory class.
FontMapping<T extends org.apache.fontbox.FontBoxFont> - Class in org.apache.pdfbox.pdmodel.font
A font mapping from a PDF font to a FontBox font.
FontMapping(T, boolean) - Constructor for class org.apache.pdfbox.pdmodel.font.FontMapping
 
FontProvider - Class in org.apache.pdfbox.pdmodel.font
External font service provider interface.
FontProvider() - Constructor for class org.apache.pdfbox.pdmodel.font.FontProvider
 
FORCE_PARSING - Static variable in class org.apache.pdfbox.cos.COSString
 
forEach(BiConsumer<? super COSName, ? super COSBase>) - Method in class org.apache.pdfbox.cos.COSDictionary
Convenience method that calls Map.forEach(BiConsumer).
FORM - Static variable in class org.apache.pdfbox.cos.COSName
 
FORM - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Form
format() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter
Format the text block.
format(PDActionJavaScript, String) - Method in interface org.apache.pdfbox.pdmodel.interactive.form.ScriptingHandler
Handle the fields format event action.
formatFloatFast(float, int, byte[]) - Static method in class org.apache.pdfbox.util.NumberFormatUtil
Fast variant to format a floating point value to a ASCII-string.
formatterRectangleParameters(int[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Sets formatter PDRectangle
FORMTYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
FreeXReference - Class in org.apache.pdfbox.pdfparser.xref
A class representing a free reference in a PDF's crossreference stream (PDFXRefStream).
FreeXReference(COSObjectKey, long) - Constructor for class org.apache.pdfbox.pdfparser.xref.FreeXReference
Sets the given COSObjectKey as a free reference in a PDF's crossreference stream (PDFXRefStream).
FRM - Static variable in class org.apache.pdfbox.cos.COSName
 
fromFontBox(Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
Creates an encoding from the given FontBox encoding.
fromInt(int) - Static method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
 
fromString(String) - Static method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingIntent
 
fromString(String) - Static method in enum org.apache.pdfbox.pdmodel.PageLayout
 
fromString(String) - Static method in enum org.apache.pdfbox.pdmodel.PageMode
 
FS - Static variable in class org.apache.pdfbox.cos.COSName
 
FT - Static variable in class org.apache.pdfbox.cos.COSName
 
FUNCTION - Static variable in class org.apache.pdfbox.cos.COSName
 
FUNCTION_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
FUNCTIONS - Static variable in class org.apache.pdfbox.cos.COSName
 

G

G - Static variable in class org.apache.pdfbox.cos.COSName
 
GAMMA - Static variable in class org.apache.pdfbox.cos.COSName
 
GARBAGE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
Garbage bytes used to create the PDF header.
generateAppearanceStreams() - Method in interface org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler
 
generateDownAppearance() - Method in interface org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCaretAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCircleAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFileAttachmentAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFreeTextAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDHighlightAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDInkAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLineAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLinkAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolygonAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolylineAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSoundAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquareAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquigglyAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDStrikeoutAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler
 
generateDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDUnderlineAppearanceHandler
 
generateNormalAppearance() - Method in interface org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCaretAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCircleAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFileAttachmentAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFreeTextAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDHighlightAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDInkAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLineAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLinkAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolygonAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolylineAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSoundAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquareAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquigglyAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDStrikeoutAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler
 
generateNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDUnderlineAppearanceHandler
 
generatePatch(Point2D[], float[][]) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
 
generatePatch(Point2D[], float[][]) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
 
generateRolloverAppearance() - Method in interface org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCaretAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCircleAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFileAttachmentAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFreeTextAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDHighlightAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDInkAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLineAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLinkAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolygonAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolylineAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSoundAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquareAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquigglyAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDStrikeoutAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler
 
generateRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDUnderlineAppearanceHandler
 
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.PDPageTree
Returns the page at the given index.
get(Object) - Method in class org.apache.pdfbox.util.SmallMap
 
getAccessPermission() - Method in class org.apache.pdfbox.pdfparser.COSParser
This will get the AccessPermission.
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
Get the documents AcroForm.
getAcroForm(PDDocumentFixup) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
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
getAcroFormMergeMode() - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Get the merge mode to be used for merging AcroForms between documents PDFMergerUtility.AcroFormMergeMode
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.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.text.PDFTextStripper
This will tell if the text stripper should add some more text formatting.
getAdobeGlyphList() - Static method in class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Returns the Adobe Glyph List (AGL).
getAffineTransform() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets AffineTransform
getAFM(String) - Static method in class org.apache.pdfbox.pdmodel.font.Standard14Fonts
Returns the metrics for font specified by fontName.
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.
getAlphaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the stroke alpha constant property.
getAlphaSourceFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the alpha source flag (“alpha is shape”), that specifies whether the current soft mask and alpha constant shall be interpreted as shape values (true) or opacity values (false).
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.PDICCBased
Returns a list of alternate color spaces for non-conforming readers.
getAlternateColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Returns the colorant name.
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 ("shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to 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.
getAnnotationFilter() - Method in class org.apache.pdfbox.rendering.PageDrawer
Return the AnnotationFilter.
getAnnotationFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the flags for this field.
getAnnotationIndex() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
If the value in the /A entry is an integer, this will get the index (zero-based) of the annotation in the /Annots array of the page specified by the /P entry.
getAnnotationName() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
If the value in the /A entry is a string, this will get the value of the /NM entry in the annotation dictionary.
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.
getAnnotations(AnnotationFilter) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will return a list of the annotations for this page.
getAnnotationsFilter() - Method in class org.apache.pdfbox.rendering.PDFRenderer
Return the AnnotationFilter.
getAntiAlias() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
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(PDAnnotation) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Returns the appearance stream to process for the given annotation.
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.
getAppearanceState() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Returns the annotations appearance state, which selects the applicable appearance stream from an appearance subdictionary.
getAppearanceStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
Returns the entry as an appearance stream.
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.
getArmStyle() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
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 is the CropBox.
getArticleEnd() - Method in class org.apache.pdfbox.text.PDFTextStripper
Returns the string which will be used at the end of an article.
getArticleStart() - Method in class org.apache.pdfbox.text.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.
getASCII() - Method in class org.apache.pdfbox.cos.COSString
Returns the content of this string as a PDF ASCII 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
Returns the attributes 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.state.PDExtendedGraphicsState
This will get the automatic stroke adjustment flag.
getAverageCharTolerance() - Method in class org.apache.pdfbox.text.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
 
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
This will get the average font width for all characters.
getAverageFontWidth() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
This will get the average font width for all characters.
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the average width for the font.
getB() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Returns the b value of the tristimulus.
getB() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
 
getBackdropColor() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Returns the backdrop color.
getBackground() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
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.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
Returns the base color space.
getBaseEncoding() - Method in class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
Returns the base encoding.
getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
The PostScript name of the font.
getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Returns the PostScript name of the font.
getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the PostScript name of the font.
getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
Returns the PostScript name of the font.
getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
Returns 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 interface org.apache.pdfbox.contentstream.PDContentStream
Returns the bounding box of the contents.
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.font.PDType3CharProc
 
getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
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.graphics.pattern.PDTilingPattern
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.PDShading
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 shading'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.
getBBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
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.
getBFCOSObjectOffsets() - Method in class org.apache.pdfbox.pdfparser.BruteForceParser
Returns all found objects of a brute force search.
getBitsPerComponent() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns bits per component of this image, or -1 if one has not been set.
getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.PDCIEDictionaryBasedColorSpace
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.
getBlendChannelFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Returns the blend channel function, only available for separable blend modes.
getBlendFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Returns the blend function, only available for non separable blend modes.
getBlendMode() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
Returns the blending mode stored in the COS dictionary
getBlendMode() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Returns the current blend mode
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.
getBorder() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the border array.
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.fdf.FDFAnnotation
This will retrieve the border style dictionary, describing the effect applied to the border described by the BS entry.
getBorderEffect() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
getBorderEffect() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will retrieve the border effect dictionary, specifying effects to be applied used in drawing the line.
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.fdf.FDFAnnotation
This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the annotation.
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.PDAnnotationMarkup
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.
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getBoundingBox() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the font's bounding box.
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getBounds() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
Returns all bounds values as COSArray.
getBounds(AffineTransform, Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Calculate a bounding rectangle around the areas of this shading context.
getBounds(AffineTransform, Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
 
getBounds(AffineTransform, Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
 
getBRange() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
This will get the valid range for the "b" component.
getByteOffset() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns the byte offset of the COSObject in the PDF file.
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
Returns the raw bytes of the string using a new byte array.
getBytes() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getBytes() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFAResource
Get the XFA content as byte array.
getBytes(byte) - Static method in class org.apache.pdfbox.util.Hex
Returns the bytes corresponding to the ASCII hex encoding of the given byte.
getBytes(byte[]) - Static method in class org.apache.pdfbox.util.Hex
Returns the bytes corresponding to the ASCII hex encoding of the given bytes.
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.
getCalcOrder() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Return the calculation order in which field values should be recalculated when the value of any field changes.
getCallout() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will get the coordinates of the callout line.
getCallout() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will get the coordinates of the callout line.
getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the CapHeight for the font.
getCaption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve if the contents are shown as a caption or not.
getCaptionHorizontalOffset() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the horizontal offset of the caption.
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.
getCaptionStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the caption positioning.
getCaptionVerticalOffset() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the vertical offset of the caption.
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.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.
getCFFFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
Returns the embedded CFF CIDFont, or null if the substitute is not a CFF font.
getCFFType1Font() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
Returns the embedded Type 1-equivalent CFF font.
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.
getCharacterCodes() - Method in class org.apache.pdfbox.text.TextPosition
Return the internal PDF character codes of the glyphs in this text.
getCharactersByArticle() - Method in class org.apache.pdfbox.text.PDFTextStripper
Character strings are grouped by articles.
getCharacterSpacing() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Get the value of the characterSpacing.
getCharProc(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
Returns the stream of the glyph for the given character code
getCharProcs() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
Returns the dictionary containing all streams to be used to render the glyphs.
getChars(short) - Static method in class org.apache.pdfbox.util.Hex
Returns the characters corresponding to the ASCII hex encoding of the given short.
getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the character set for the font.
getCharsUTF16BE(String) - Static method in class org.apache.pdfbox.util.Hex
Takes the characters in the given string, convert it to bytes in UTF16-BE format and build a char array that corresponds to the ASCII hex encoding of the resulting bytes.
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.
getChildren() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Returns this field's children.
getCIDFont(String, PDFontDescriptor, PDCIDSystemInfo) - Method in interface org.apache.pdfbox.pdmodel.font.FontMapper
Finds a CFF CID-Keyed font with the given PostScript name, or a suitable substitute, or null.
getCIDSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Get the CIDSet stream.
getCIDSystemInfo() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the CIDSystemInfo associated with the font, if present.
getCIDSystemInfo() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Returns the CIDSystemInfo, or null if it is missing (which isn't allowed but could happen).
getClassMap() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the ClassMap.
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 FDF field dictionary.
getClearWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the 'ClrF' entry of the FDF field dictionary.
getCMap() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the font's CMap.
getCmapLookup() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the CMap lookup table if present.
getCMapUCS2() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the font's UCS2 CMap, only present this font uses a predefined CMap.
getCodePageRange1() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the ulCodePageRange1 field of the "OS/2" table, or 0.
getCodePageRange2() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the ulCodePageRange2 field of the "OS/2" table, or 0.
getCodeToNameMap() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
Returns an unmodifiable view of the code -> name mapping.
getColor() - Method in class org.apache.pdfbox.contentstream.operator.color.SetColor
Returns either the stroking or non-stroking color value.
getColor() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColor
Returns the non-stroking color.
getColor() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColor
Returns the stroking color.
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.
getColor() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will retrieve the color used in drawing various elements.
getColor(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
 
getColorantName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Returns the colorant name.
getColorantNames() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Returns the list of colorants.
getColorants() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Returns a map of colorants and their associated Separation color space.
getColorKeyMask() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns the color key mask array associated with this image, or null if there is none.
getColorModel() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
 
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.contentstream.operator.color.SetColor
Returns either the stroking or non-stroking color space.
getColorSpace() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColor
Returns the non-stroking color space.
getColorSpace() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColor
Returns the stroking color space.
getColorSpace(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns the color space in which this color value is defined.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
Returns the process color space
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Returns the group color space or null if it isn't defined.
getColorSpace(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Returns the group color space or null if it isn't defined.
getColorSpace() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the image's color space.
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will get the color space or null if none exists.
getColorSpace(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the color space resource with the given name, or null if none exists.
getColorSpace(COSName, boolean) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the color space resource with the given name, or null if none exists.
getColorSpace(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the color space resource for the given indirect object, if it is in the cache.
getColorSpaceNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the color space resources, if any.
getColorSpaceType() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Returns the type of the color space in the ICC profile.
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).
getComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns the components of this color value.
getComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
Returns the names of the color components.
getCompressionLevel() - Static method in class org.apache.pdfbox.filter.Filter
 
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 provided by the signer to enable a recipient to contact the signer to verify the signature, e.g.
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.
getContent() - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.ExternalSigningSupport
Get PDF content to be signed.
getContent() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SigningSupport
 
getContents() - Method in interface org.apache.pdfbox.contentstream.PDContentStream
Returns this stream's content, if any.
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.fdf.FDFAnnotation
Get the text, or a description, of the annotation.
getContents() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getContents() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
 
getContents() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
 
getContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the "contents" of the field.
getContents() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Returns the /Contents string as a byte array, i.e.
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
Returns the content stream(s) of this page as a single input stream.
getContentsForRandomAccess() - Method in interface org.apache.pdfbox.contentstream.PDContentStream
Returns this stream's content, if any.
getContentsForRandomAccess() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getContentsForRandomAccess() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
 
getContentsForRandomAccess() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
 
getContentsForRandomAccess() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
getContentStream() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getContentStream() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
 
getContentStream() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
 
getContentStreams() - Method in class org.apache.pdfbox.pdmodel.PDPage
Returns the content streams which make up this page.
getContext() - Method in class org.apache.pdfbox.contentstream.operator.OperatorProcessor
Returns the processing context.
getContrast() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getConversionFactor() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the conversion factor.
getCoords() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup
Get the coordinates of individual words or group of words.
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(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 COSArray.
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.
getCOSBase() - Method in enum org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionDirection
 
getCOSDictionary(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 COSDictionary.
getCOSDictionary(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 a COSDictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Returns the underlying COS dictionary.
getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
Returns the underlying COS dictionary.
getCOSName(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.
getCOSName(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 a name.
getCOSName() - Method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
The blend mode name from the BM object.
getCOSObject() - Method in class org.apache.pdfbox.cos.COSBase
Convert this standard java object to a COS object.
getCOSObject(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 COSObject.
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 stream.
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.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
Returns the underlying dictionary.
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
Get the cos stream associated with this 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
Returns the underlying dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDParentTreeValue
 
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.markedcontent.PDPropertyList
 
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.encryption.PDCryptFilterDictionary
This will get the dictionary associated with this crypt filter dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will get the dictionary associated with this encryption dictionary.
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.encoding.BuiltInEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.MacExpertEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.MacOSRomanEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.MacRomanEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.StandardEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.SymbolEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.WinAnsiEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.encoding.ZapfDingbatsEncoding
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDSystemInfo
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceColorSpace
 
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.PDJPXColorSpace
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
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.form.PDTransparencyGroupAttributes
 
getCOSObject() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Convert this image to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.PDAbstractPattern
This will get the underlying dictionary.
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
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDXObject
Returns the stream.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will get the underlying dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the underlying dictionary that this class acts on.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAction
Convert this standard java object to a COS object.
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.PDTargetDirectory
This will get the underlying dictionary that this class acts on.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDURIDictionary
Returns the corresponding dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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
returns the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
 
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
returns the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuild
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueMDP
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Convert this standard java object to a COS dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Convert this standard java object to a COS dictionary.
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.form.PDAcroForm
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the dictionary associated with this field.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFAResource
Convert this standard java object to a COS object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
This will return the corresponding dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will return the corresponding dictionary.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
This will get the underlying dictionary that this object wraps.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
This will get the underlying dictionary that this object wraps.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
This will get the underlying dictionary that this object wraps.
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
This will get the underlying dictionary that this object wraps.
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.PDPageTree
 
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the underlying dictionary.
getCOSStream(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 COSStream.
getCOSValue() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
Returns the COS value of this field.
getCount() - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Returns the number of leaf nodes (page objects) that are descendants of this root within the page tree.
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.
getCryptFilterDictionary(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
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.state.PDGraphicsState
This will get the current clipping path.
getCurrentClippingPaths() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will get the current clipping path, as one or more individual paths.
getCurrentPage() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Returns the current page.
getCurrentPageNo() - Method in class org.apache.pdfbox.text.PDFTextStripper
Get the current page number that is being processed.
getCurrentPoint() - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Returns the current point of the current path.
getCurrentPoint() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
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.state.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.PDActionLaunch
This will get the string specifying the default directory in standard DOS syntax.
getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
This will get the destination to jump to.
getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
 
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.
getDashArray() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Returns the dash array.
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.pdmodel.graphics.image.PDInlineImage
Returns the inline image data.
getDataToSign() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
Return the stream of PDF data to be signed.
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 interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the decode array.
getDecode() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getDecode() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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(COSDictionary, int) - Method in class org.apache.pdfbox.filter.Filter
 
getDecodeParms() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Get the list of decode parameters.
getDecodeResult() - Method in class org.apache.pdfbox.cos.COSInputStream
Returns the result of the last filter, for use by repair mechanisms.
getDecryptionCertificate() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns the decryption certificate.
getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Get the default appearance string.
getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Get the default appearance.
getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Get the default appearance.
getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Get the default appearance.
getDefaultAppearanceString() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will get the string of default appearance string.
getDefaultCryptFilterDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns the default crypt filter (for public-key security handler).
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the default decode array for this color space.
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
getDefaultDecode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
getDefaultDestination() - Method in class org.apache.pdfbox.rendering.PDFRenderer
 
getDefaultFont() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
 
getDefaultOverlayFile() - Method in class org.apache.pdfbox.multipdf.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 AcroForm.
getDefaultStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Get the default style string.
getDefaultStyleString() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Get the default style string.
getDefaultStyleString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Get the default style string.
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Returns the default value, if any.
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Returns the default values, or an empty List.
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Returns the default value of this field.
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Returns the default value, if any.
getDefaultValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
Returns the default value of this field, or an empty string.
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
Returns the descendant font.
getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the descent for the font.
getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
This will get the destination to jump to.
getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.rendering.PageDrawerParameters
 
getDestinationDocument() - Method in class org.apache.pdfbox.multipdf.Splitter
The source PDF document.
getDestinationDocumentInformation() - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
getDestinationFileName() - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Get the name of the destination file.
getDestinationMetadata() - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
getDestinationStream() - Method in class org.apache.pdfbox.multipdf.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.
getDictionaryObject(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
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(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This will get an object from this dictionary.
getDifferences() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will get the incremental updates since the PDF was last opened.
getDifferences() - Method in class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
Returns the Differences array.
getDigestMethod() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
An array of names indicating acceptable digest algorithms to use when signing.
getDimension() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
getDir() - Method in class org.apache.pdfbox.text.TextPosition
Return the direction/orientation of the string in this object based on its text matrix.
getDirection() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
getDirectory() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
The dir to launch from.
getDisplacement(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the displacement vector (w0, w1) in text space, for the given character.
getDisplacement(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getDisplacement(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getDistances() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will return the distances.
getDoc() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Returns the dictionary's "Doc" entry, that is, a map of key value pairs to be added to the document's JavaScript name tree.
getDocument() - Method in class org.apache.pdfbox.multipdf.LayerUtility
Returns the PDF document we work on.
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.PDXFAResource
Get the XFA content as W3C document.
getDocument() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the low level document.
getDocumentCatalog() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the document CATALOG.
getDocumentID() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the document ID.
getDocumentId() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Provides the document ID.
getDocumentInformation() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the document info dictionary.
getDocumentMergeMode() - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Get the merge mode to be used for merging documents PDFMergerUtility.DocumentMergeMode
getDocumentOutline() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the outline associated with this document or null if it does not exist.
getDocumentState() - Method in class org.apache.pdfbox.cos.COSDocument
Returns the COSDocumentState of this COSDocument.
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.text.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.
getDuration() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
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).
getEmbeddedDate(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 a name and convert it to a string.
getEmbeddedDate(COSName, 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(COSName, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedInt(COSName, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
Get an integer from an embedded dictionary.
getEmbeddedString(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 a name and convert it to a string.
getEmbeddedString(COSName, 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() - 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.PDSimpleFont
Returns the Encoding.
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.BuiltInEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.DictionaryEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
Returns the name of this encoding.
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.MacExpertEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.MacRomanEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.StandardEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.SymbolEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.WinAnsiEncoding
 
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.ZapfDingbatsEncoding
 
getEncryption() - Method in class org.apache.pdfbox.pdfparser.COSParser
This will get the encryption dictionary.
getEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the encryption dictionary for this document.
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.
getEncryptionKey() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Returns the current encryption key data.
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.text.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.multipdf.PageExtractor
Gets the last page number (inclusive) to be extracted.
getEndPage() - Method in class org.apache.pdfbox.text.PDFTextStripper
This will get the last page that will be extracted.
getEndPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
getEndPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
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.
getEndPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
This will retrieve the line ending style for the end point, possible values shown in the LE_ constants section.
getEndX() - Method in class org.apache.pdfbox.text.TextPosition
This will get the x coordinate of the end position.
getEndY() - Method in class org.apache.pdfbox.text.TextPosition
This will get the y coordinate of the end position.
getExecuteParam() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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).
getExportValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
This will get the (optional) export values.
getExportValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
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.PDShadingPattern
This will get the external 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.
getExtGState(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getExtGState(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the extended graphics state resource with the given name, or null if none exists.
getExtGState(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the extended graphics state resource for the given indirect object, if it is in the cache.
getExtGStateNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the extended graphics state resources, if any.
getF() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This will get the file name to be launched or the document to be opened or printed, in standard Windows pathname format.
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.
getFamilyClass() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the sFamilyClass field of the "OS/2" table, or -1.
getFamilyClass() - Method in class org.apache.pdfbox.pdmodel.font.PDPanose
The font family class and subclass ID bytes, given in the sFamilyClass field of the “OS/2” table in a TrueType font.
getFamilyKind() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getFDF() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will get the FDF dictionary.
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 FDF field dictionary.
getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will get the flags for this field.
getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
 
getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
 
getFieldIterator() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Returns an iterator which walks all fields in the field tree, in order.
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.action.PDActionResetForm
An array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entry
getFields() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
An array identifying which fields to include in the submission or which to exclude, depending on the setting of the Include/Exclude flag in the Flags entry
getFields() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will return all of the documents root fields.
getFieldTree() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Return the field tree representing all form fields
getFieldType() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Get the FT entry of the field.
getFieldType() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Get the FT entry of the field.
getFieldType() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
 
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.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.PDActionEmbeddedGoTo
This will get the file in which the destination is located.
getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData
This will get the file in which the destination is located.
getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.PDActionRemoteGoTo
This will get the file in which the destination is located.
getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
This will get the file in which the destination is located.
getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
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.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.PDStream
This will get the list of filters that are associated with this stream.
getFileMac() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
This will get the name representing a Mac file.
getFilename() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
Preferred method for getting the filename.
getFilename() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Get the name of the file as found in the EmbeddedFiles name tree.
getFilename() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
The file to launch.
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(String) - Method in class org.apache.pdfbox.filter.FilterFactory
Returns a filter instance given its name as a string.
getFilter(COSName) - Method in class org.apache.pdfbox.filter.FilterFactory
Returns a filter instance given its COSName.
getFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Get the name of the filter.
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.
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.pdmodel.common.PDStream
This will get the list of filters that are associated with this stream.
getFilters() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
Returns A list of filters applied to 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.
getFirstChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
 
getFirstColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.AbstractXReference
Returns the value for the first column of the crossreference stream entry.
getFirstColumnValue() - Method in interface org.apache.pdfbox.pdfparser.xref.XReferenceEntry
Returns the value for the first column of the crossreference stream entry.
getFirstTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns the first trailer if at least one exists.
getFlag(COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
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.interactive.action.PDActionResetForm
A set of flags specifying various characteristics of the action
getFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
A set of flags specifying various characteristics of the action
getFlatness() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
get the value of the flatness property.
getFlatnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the flatness tolerance.
getFloat(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float.
getFloat(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float.
getFloat(String, float) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be a float.
getFloat(COSName, float) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an float.
getFlyScale() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
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(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getFont(FontInfo) - Method in class org.apache.pdfbox.pdmodel.font.FontCache
Returns the FontBox font associated with the given FontInfo.
getFont() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns a new FontBox font instance for the font.
getFont() - Method in class org.apache.pdfbox.pdmodel.font.FontMapping
Returns the mapped, FontBox font.
getFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
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.graphics.state.PDTextState
Get the value of the font.
getFont(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the font resource with the given name, or null if none exists.
getFont(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the font resource for the given indirect object, if it is in the cache.
getFont() - Method in class org.apache.pdfbox.text.TextPosition
This will get the font for the text being drawn.
getFontBBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
This will get the fonts bounding box from its dictionary.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the fonts bounding box.
getFontBoxFont(String, PDFontDescriptor) - Method in interface org.apache.pdfbox.pdmodel.font.FontMapper
Finds a font with the given PostScript name, or a suitable substitute, or null.
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
Returns the embedded or substituted font.
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns the embedded or system font used for rendering.
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getFontBoxFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
getFontDescriptor() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the font descriptor, may be null.
getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A string representing the preferred font family.
getFontFile() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A stream containing a Type 1 font program.
getFontFile2() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A stream containing a true type font program.
getFontFile3() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A stream containing a font program that is not true type or type 1.
getFontInfo() - Method in class org.apache.pdfbox.pdmodel.font.FontProvider
Returns a list of information about fonts on the system.
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
getFontMatrix() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the font matrix, which represents the transformation from glyph space to text space.
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Get the font name.
getFontNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the font resources, if any.
getFontSetting() - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.graphics.state.PDTextState
Get the value of the fontSize.
getFontSize() - Method in class org.apache.pdfbox.text.TextPosition
This will get the font size that has been set with the "Tf" operator (Set text font and size).
getFontSizeInPt() - Method in class org.apache.pdfbox.text.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.
getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
The weight of the font.
getForceHexForm() - Method in class org.apache.pdfbox.cos.COSString
Returns true if the string is to be written in hex form.
getFormat() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the font's format.
getFormattedValue() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Returns the string for the property value.
getFormatterRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets formatter rectangle
getFormatterRectangleParameters() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getFormType() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
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.
To quote the PDF Spec "An array of two numbers between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the icon.
getFringe() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
This will retrieve the fringe.
getFringe() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
This will get the fringe.
getFringe() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will get the fringe.
getFringe() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
This will get the fringe.
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.shading.AxialShadingContext
Returns the function.
getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
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.
getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity
 
getG() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Returns 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
Returns the gamma value.
getGeneration() - Method in class org.apache.pdfbox.cos.COSObjectKey
This will get the object generation number.
getGenerationNumber() - Method in class org.apache.pdfbox.cos.COSObject
Getter for property generationNumber.
getGIDToCode() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Inverts the font's code -> GID mapping.
getGlyphBBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
Calculate the bounding box of this glyph.
getGlyphList() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns the glyphlist.
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).
getGlyphPath(Standard14Fonts.FontName, String) - Static method in class org.apache.pdfbox.pdmodel.font.Standard14Fonts
Returns the path for the character with the given name for the specified Standard 14 font.
getGraphics() - Method in class org.apache.pdfbox.rendering.PageDrawer
Returns the underlying Graphics2D.
getGraphicsContext() - Method in class org.apache.pdfbox.contentstream.operator.graphics.GraphicsOperatorProcessor
GraphicsOperatorProcessor uses a spezialized engine.
getGraphicsStackSize() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
getGraphicsState() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
getGroup() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Returns the group attributes dictionary.
getGroup(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Returns the first optional content group of the given name.
getGroup() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Returns the G entry of the soft mask object
getGroupNames() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Lists all optional content group names.
getGsubData() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Returns the GSubData if present.
getGuidelineColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Get the RGB 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.
getH() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
A flag indicating whether to hide the annotation or show it
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).
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(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getHeight(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Deprecated.
Use getBoundingBox().getHeight() instead.
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getHeight() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns height of this image, or -1 if one has not been set.
getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getHeight() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getHeight() - Method in class org.apache.pdfbox.text.TextPosition
This will get the maximum height of all characters in this string.
getHeightDir() - Method in class org.apache.pdfbox.text.TextPosition
This will get the maximum height of all characters in this string.
getHighestXRefObjectNumber() - Method in class org.apache.pdfbox.cos.COSDocument
Internal PDFBox use only.
getHighestXRefObjectNumber() - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Returns the highest known object number (see: COSObjectKey for further information), that is currently registered in this pool.
getHighestXRefObjectNumber() - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns the highest object number, that is registered in this compression pool.
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.
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
getHorizontalScaling() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Get the value of the horizontalScaling.
getICCProfile() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
getIcon() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
This will retrieve the icon (and hence appearance, AP taking precedence) For this annotation.
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.
getImage() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the content of this image as an AWT buffered image with an (A)RGB color space.
getImage(Rectangle, int) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the content of this image as an AWT buffered image with an (A)RGB colored space.
getImage() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns the content of this image as an AWT buffered image with an (A)RGB color space.
getImage(Rectangle, int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns the content of this image as an AWT buffered image with an (A)RGB colored space.
getImage() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getImage(Rectangle, int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getImage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets the image of visible signature
getImage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getImageData() - Method in class org.apache.pdfbox.contentstream.operator.Operator
This is the special case for the ID operator where there are just random bytes inlined the stream.
getImageDownscalingOptimizationThreshold() - Method in class org.apache.pdfbox.rendering.PageDrawerParameters
 
getImageDownscalingOptimizationThreshold() - Method in class org.apache.pdfbox.rendering.PDFRenderer
 
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
getImageName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets visible signature image name
getImageParameters() - Method in class org.apache.pdfbox.contentstream.operator.Operator
This will get the image parameters, this is only valid for BI operators.
getImageSizeInPercents() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
get image size in percents
getIndentThreshold() - Method in class org.apache.pdfbox.text.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.
getIndirectObjectKeys(List<COSObjectKey>) - Method in class org.apache.pdfbox.cos.COSArray
Collects all indirect objects numbers within this COSArray and all included dictionaries.
getIndirectObjectKeys(List<COSObjectKey>) - Method in class org.apache.pdfbox.cos.COSDictionary
Collects all indirect objects numbers within this dictionary and all included dictionaries.
getIndividualWidths() - Method in class org.apache.pdfbox.text.TextPosition
Get the widths of each individual character.
getInfo() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getInheritableAttribute(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Returns the given attribute, inheriting from parent nodes if necessary.
getInheritableAttribute(COSDictionary, COSName) - Static method in class org.apache.pdfbox.pdmodel.PDPageTree
Returns the given attribute, inheriting from parent tree nodes if necessary.
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the initial color value for this color space.
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
getInitialColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
getInitialMatrix() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Gets the stream's initial matrix.
getInitialTransformationMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Returns the CTM at the time the ExtGState was activated.
getInkList() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
Get the paths making up the freehand "scribble".
getInkList() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
Get one or more disjoint paths that make this annotation.
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
getInnerFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Inner form Stream.
getInputFile() - Method in class org.apache.pdfbox.multipdf.Overlay
Returns the input file.
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(COSName) - Static method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
This will get an encoding by name.
getInstance(BlendMode, float) - Static method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendComposite
Creates a blend composite
getInstance(COSBase) - Static method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Determines the blend mode from the BM entry in the COS ExtGState.
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.
getInt(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an int.
getInt(String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an integer.
getInt(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.fdf.FDFAnnotation
Get the intent of the annotation.
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.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
This will retrieve the interior color of the drawn area.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the interior color of the line endings defined in the LE entry.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
This will get interior color of the drawn area.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will retrieve the interior color of the line endings defined in the LE entry.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
This will retrieve the interior color of the drawn area.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve the interior color of the line endings defined in the LE entry.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will retrieve the interior color.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
This will retrieve the interior color with which to fill the annotation’s line endings.
getInteriorColor() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will retrieve the interior color of the drawn area color is in DeviceRGB color space.
getInternalHash() - Method in class org.apache.pdfbox.cos.COSObjectKey
Return the internal hash value which is based on the number and the generation.
getInterpolate() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns true if the image should be interpolated when rendered.
getInterpolate() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getInterpolate() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getIssuer() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Returns list of array of bytes of DER-encoded X.509v3 certificates
getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
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, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a special case of getItem 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.
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 name tree.
getJPXColorSpace() - Method in class org.apache.pdfbox.filter.DecodeResult
Returns the embedded JPX color space, if any.
getJustification() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will get the form of quadding (justification) of the annotation text.
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.
getKey() - Method in class org.apache.pdfbox.cos.COSBase
This will return the COSObjectKey of an indirect object.
getKey(COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Returns the COSObjectKey for a given registered COSBase.
getKey(COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns the COSObjectKey, that is registered for the given COSBase in this compression pool.
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.
getKeyUsage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Returns list of key usages of certificate strings where each string is 9 characters long and each character is one of these values {0, 1, X} 0 for must not set, 1 for must set, X for don't care.
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.
getKnockoutFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.state.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
Returns the language for the document, or null.
getLastChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
 
getLastSignatureDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will return the last signature from the field tree.
getLastTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns the last trailer if at least one exists.
getLeaderExtend() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the length of the leader line extensions.
getLeaderLength() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the length of the leader line.
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.
getLeaderOffset() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
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.graphics.state.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.cos.COSStream
Returns the length of the encoded 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.

The length in bits for the crypt filter algorithm.
getLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will return the Length entry of the encryption dictionary.

The length in bits for the encryption algorithm.
getLetterform() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getLevel() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Get the current level.
getLine() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the start and end coordinates of the line (or leader line if LL entry is set).
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).
getLinearizedDictionary() - Method in class org.apache.pdfbox.cos.COSDocument
Get the dictionary containing the linearization information if the pdf is linearized.
getLineCap() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the line cap.
getLineCapStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.state.PDExtendedGraphicsState
This will get the dash pattern.
getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will get the current line dash pattern.
getLineEndingStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will retrieve the line ending style.
getLineEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will retrieve the line ending style.
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.state.PDGraphicsState
Get the value of the line join.
getLineJoinStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the line join style.
getLinePath() - Method in class org.apache.pdfbox.rendering.PageDrawer
Returns the current line path.
getLineSeparator() - Method in class org.apache.pdfbox.text.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.state.PDExtendedGraphicsState
This will get the line width.
getLineWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the line width.
getListItemPatterns() - Method in class org.apache.pdfbox.text.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 CPU host name or physical location of the signing.
getLong(String) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long.
getLong(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an long.
getLong(String, long) - Method in class org.apache.pdfbox.cos.COSDictionary
This is a convenience method that will get the dictionary object that is expected to be an 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.
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 number 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.
getMacStyle() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the macStyle field of the "head" table, or -1.
getMacSubtype() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the mac subtype.
getMappedFontName(String) - Static method in class org.apache.pdfbox.pdmodel.font.Standard14Fonts
Returns the base name of the font which the given font name maps to.
getMappingName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Gets the mapping name of the field.
getMarkedContents() - Method in class org.apache.pdfbox.text.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.image.PDImageXObject
Returns the Mask Image XObject associated with this image, or null if there is none.
getMatrix() - Method in interface org.apache.pdfbox.contentstream.PDContentStream
Returns the matrix which transforms from the stream's space to user space.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Returns the linear interpretation matrix, which is an array of nine numbers.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
This will get the optional matrix of an XObjectForm.
getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Returns the pattern matrix, or the identity matrix is none is available.
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.shading.ShadingPaint
 
getMatrix() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
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.PDTextField
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.
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.
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
Returns the metadata stream for this object, or null if there is no metadata stream.
getMetadata() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns the metadata associated with this XObject, or null if there is none.
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.
getMidline() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
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 from the /MissingWidth dictionary entry.
getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the miter limit.
getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the miter limit.
getMix() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Gets the flag specifying whether to mix this sound with any other sound already playing.
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.
getMotion() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
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.PDActionNamed
This will get the name of the action to be performed.
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColorN
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColorSpace
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceCMYKColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceGrayColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceRGBColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColorN
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColorSpace
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceCMYKColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceGrayColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceRGBColor
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.DrawObject
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.AppendRectangleToPath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.BeginInlineImage
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClipEvenOddRule
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClipNonZeroRule
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseAndStrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseFillEvenOddAndStrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseFillNonZeroAndStrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClosePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveTo
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateFinalPoint
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateInitialPoint
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.DrawObject
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.EndPath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddAndStrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddRule
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroAndStrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroRule
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.LegacyFillNonZeroRule
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.LineTo
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.MoveTo
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.ShadingFill
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.graphics.StrokePath
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequence
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequenceWithProperties
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.DrawObject
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.EndMarkedContentSequence
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.Operator
This will get the name of the operator.
getName() - Method in class org.apache.pdfbox.contentstream.operator.OperatorProcessor
Returns the name of this operator, e.g.
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.Concatenate
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.Restore
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.Save
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetFlatness
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetGraphicsStateParameters
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineCapStyle
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineDashPattern
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineJoinStyle
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineMiterLimit
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineWidth
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetMatrix
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.state.SetRenderingIntent
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.BeginText
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.EndText
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.MoveText
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.MoveTextSetLeading
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.NextLine
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetCharSpacing
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetFontAndSize
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextHorizontalScaling
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextLeading
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextRenderingMode
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextRise
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.SetWordSpacing
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.ShowText
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextAdjusted
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextLine
 
getName() - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextLineAndSpace
 
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() - 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(int) - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
This will take a character code and get the name from the code.
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
getName() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the name of this font, either the PostScript "BaseName" or the Type 3 "Name".
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getName() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getName() - Method in enum org.apache.pdfbox.pdmodel.font.Standard14Fonts.FontName
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the name of the color space.
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
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.PDOptionalContentGroup.RenderState
Returns the PDF name for the state.
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.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 of the person or authority signing the document.
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.action.PDTargetDirectory
If the value in the /P entry is a string, this will get a named destination in the current document that provides the page number of the file attachment annotation.
getNamedDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
This will get the name of the destination.
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 on this level.
getNames() - Static method in class org.apache.pdfbox.pdmodel.font.Standard14Fonts
Returns the set of known font names, including aliases.
getNames() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
 
getNameToCodeMap() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
Returns an unmodifiable view of the name -> code mapping.
getNeedAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
True if the viewing application should construct the appearances of all field widgets.
getNext() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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
 
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.
getNonStrokeAlphaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the non-stroke alpha constant property.
getNonStrokingAlphaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the non stroking alpha constant.
getNonStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Returns the non-stroking color.
getNonStrokingColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Returns the non-stroking color space.
getNonStrokingJavaComposite() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
getNonStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the overprint control for non stroking operations.
getNonStrokingPaint() - Method in class org.apache.pdfbox.rendering.PageDrawer
Returns the non-stroking AWT Paint.
getNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
This will return a list of appearances.
getNormalAppearanceStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Returns the appearance stream for this annotation, if any.
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.
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getNormalizedPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getNormalizedPath(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDVectorFont
Returns the normalized glyph path for the given character code in a PDF.
getNumber() - Method in class org.apache.pdfbox.cos.COSObjectKey
This will get the 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.
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the number of components in this color space
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
Returns the number of components in this color space
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
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
This will return the total page count of the PDF document.
getNumberOfPages() - Method in class org.apache.pdfbox.printing.PDFPageable
 
getNumberOfRecipients() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Returns the number of recipients
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.
getNumericValue() - Method in enum org.apache.pdfbox.pdfparser.xref.XReferenceType
Returns the numeric representation of this type.
getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
This will get an action to be performed when the page is opened.
getObject(int) - Method in class org.apache.pdfbox.cos.COSArray
This will get an object from the array.
getObject() - Method in class org.apache.pdfbox.cos.COSObject
This will get the object that this object encapsulates.
getObject() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns the COSObject, that is described by this crossreference stream entry.
getObject() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the COSObject, that is described by this crossreference stream entry.
getObject(COSObjectKey) - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Returns the COSBase, that is registered for the given COSObjectKey, or null if no object is registered for that key.
getObject(COSObjectKey) - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns the COSBase, that is registered for the given COSObjectKey in this compression pool.
getObject(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Returns the object at the specified position.
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.
getObjectKey(long, int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Returns the object key for the given combination of object and generation number.
getObjectNumber() - Method in class org.apache.pdfbox.cos.COSObject
Getter for property objectNumber.
getObjects() - Method in class org.apache.pdfbox.cos.COSIncrement
Returns all indirect COSBases, that shall be written to an increment as top level COSObjects.
Calling this method will cause the increment to be initialized.
getObjectsByType(COSName) - Method in class org.apache.pdfbox.cos.COSDocument
This will get all dictionaries objects by type.
getObjectsByType(COSName, COSName) - Method in class org.apache.pdfbox.cos.COSDocument
This will get all dictionaries objects by type.
getObjectStreamIndex() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the index of the COSObject in it's containing object stream.
getObjectStreamObjects() - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns all COSBases that can be appended to an object stream.
getObjectStreamSize() - Method in class org.apache.pdfbox.pdfwriter.compress.CompressParameters
Returns the number of objects, that can be contained in compressed object streams.
getOCGs() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
Get a list of optional content groups.
getOCProperties() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the optional content properties dictionary associated with this document.
getOID() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Returns A list of array of bytes that contain Object Identifiers (OIDs) of the certificate policies that must be present in the signing certificate
getOnValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
Get the value which sets the check box to the On state.
getOnValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Get the values to set individual buttons within a group to the on state.
getOnValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
getOpacity() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the opacity value.
getOpaqueImage() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns an RGB buffered image containing the opaque image stream without any masks applied.
getOpaqueImage(Rectangle, int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns an RGB buffered image containing the opaque image stream without any masks applied.
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 or a negative number if this node is closed.
getOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.
getOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.
getOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
This will specify whether to open the destination document in a new window, in the same window, or behave in accordance with the current user preference.
getOperation() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
Get the operation to perform on the file.
getOperator(String) - Static method in class org.apache.pdfbox.contentstream.operator.Operator
This is used to create/cache operators in the system.
getOperator(String) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Operators
Returns the operator for the given operator name.
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.
getOptionalContent() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
This will get the optional content group or optional content membership dictionary.
getOptionalContent() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
This will get the optional content group or optional content membership dictionary.
getOptionalContent() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will get the optional content group or optional content membership dictionary for the annotation.
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.PDChoice
This will get the option values "Opt".
getOptionsDisplayValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will get the display values from the options.
getOptionsExportValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will get the export values from the options.
getOrder() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
Get the order of interpolation between samples.
getOrdering() - Method in class org.apache.pdfbox.pdmodel.font.CIDSystemInfo
 
getOrdering() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDSystemInfo
 
getOriginDocumentState() - Method in class org.apache.pdfbox.cos.COSUpdateState
Returns the COSUpdateState.originDocumentState, that is linked to the managed COSUpdateState.updateInfo.
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.text.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
 
getOutputIntents() - 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.state.PDExtendedGraphicsState
This will get the overprint control mode.
getOverprintMode() - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.
getOwnerEncryptionKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will get the OE entry in the standard encryption dictionary.
getOwnerKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will get the O entry in the standard encryption dictionary.
getOwnerPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Returns the owner password.
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.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() - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Returns the page.
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 0-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.
getPage(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Returns the page at the given 0-based index.
getPage() - Method in class org.apache.pdfbox.rendering.PageDrawerParameters
Returns the page.
getPageEnd() - Method in class org.apache.pdfbox.text.PDFTextStripper
Returns the string which will be used at the end of a page.
getPageFormat(int) - Method in class org.apache.pdfbox.printing.PDFPageable
Returns the actual physical size of the pages in the PDF file.
getPageHeight() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getPageHeight() - Method in class org.apache.pdfbox.text.TextPosition
This will get the height of the page that the text is located in.
getPageIndices() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
Get an ordered set of page indices having a page label range.
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
Returns the page layout.
getPageMode() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Returns the page display mode.
getPageNumber() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
If the value in the /P entry is an integer, this will get the page number (zero-based) in the current document containing the file attachment annotation.
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.PDDocument
Returns the page tree.
getPages() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Returns all pages in the document, as a page tree.
getPageStart() - Method in class org.apache.pdfbox.text.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
 
getPageWidth() - Method in class org.apache.pdfbox.text.TextPosition
This will get the width of the page that the text is located in.
getPaint(PDColor) - Method in class org.apache.pdfbox.rendering.PageDrawer
Returns an AWT paint for the given PDColor.
getPaintType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will return the paint type.
getPanose() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the Panose classification of the font, if any.
getPanose() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Returns the Panose entry of the Style dictionary, if any.
getPanose() - Method in class org.apache.pdfbox.pdmodel.font.PDPanose
Ten bytes for the PANOSE classification number for the font.
getParagraphEnd() - Method in class org.apache.pdfbox.text.PDFTextStripper
Returns the string which will be used at the end of a paragraph.
getParagraphStart() - Method in class org.apache.pdfbox.text.PDFTextStripper
Returns the string which will be used at the beginning of a paragraph.
getParameters() - Method in class org.apache.pdfbox.filter.DecodeResult
Returns the stream parameters, repaired using the embedded stream data.
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.font.PDCIDFont
Returns the Type 0 font which is the parent of this font.
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.form.PDField
Get the parent field to this field, or null if none exists.
getParentKey() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the COSObjectKey of the object stream, that is containing the object.
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.
getPartialFieldName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the "T" entry in the field dictionary.
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.
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getPath(String) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns the path for the character with the given name.
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getPath(String) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getPath(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getPath(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getPath(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getPath(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getPath(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDVectorFont
Returns the glyph path for the given character code.
getPath() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
PDF 2.0: This will retrieve the arrays that shall represent the alternating horizontal and vertical coordinates for path building.
getPattern(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getPattern(PDColor) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Returns the pattern for the given color.
getPattern(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the pattern resource with the given name, or null if none exists.
getPattern(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the pattern resource for the given indirect object, if it is in the cache.
getPatternName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns the pattern name from this color value.
getPatternNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the pattern resources, if any.
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
This will return the pattern type.
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPattern
 
getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
 
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.
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
Returns the PDFTemplateStructure object.
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 underlying ICC profile 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.PDEncryption
This will get the permissions bit mask.
getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Returns the access permissions
getPerms() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Get the Perms entry in the encryption dictionary.
getPhase() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Returns the dash 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.
getPositionVector(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
getPositionVector(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
getPositionVector(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the position vector (v), in text space, for the given character.
getPositionVector(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getPostScriptName() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the PostScript name of the font.
getPreferredSignatureSize() - 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 the preferred signature size in bytes.
getPrefix() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
Returns the page label prefix for this page range.
getPreparedKeys() - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterObjectStream
Returns all COSObjectKeys, that shall be added to the object stream, when COSWriterObjectStream.writeObjectsToStream(COSStream) is called.
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.printing.PDFPageable
 
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.
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.
getProcess() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Returns the DeviceN Process Dictionary, or null if it is missing.
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(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Gets the properties.
getProperties(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the property list resource with the given name, or null if none exists.
getProperties(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the property list resource for the given indirect object, if it is in the cache.
getPropertiesNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the property list resources, if any.
getPropertyStringValue(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
Return the properties String value.
getProportion() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getProtectionPolicy() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Returns the set ProtectionPolicy or null.
getProvider() - Static method in class org.apache.pdfbox.pdmodel.encryption.SecurityProvider
Returns the provider to be used for advanced encrypting/decrypting.
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.annotation.PDAnnotationFreeText
This will get the 'quadding' or justification of the text to be displayed.
getQ() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will get the document-wide default value for the quadding/justification of variable text fields.
getQ() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
This will get the 'quadding' or justification of the text to be displayed.
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
Returns 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 .
getRangeValues() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity
 
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
 
getRawImage() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Try to get the raw image as AWT buffered image with it's original colorspace.
getRawImage() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getRawImage() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getRawRaster() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Return the image data as WritableRaster.
getRawRaster() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getRawRaster() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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 for the signing, such as (I agree...).
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.PDEncryption
Returns the number of recipients contained in the Recipients field of the dictionary.
getRecipientStringAt(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
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.PDAnnotationFreeText
This will get the rectangle difference rectangle.
getRectDifference() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will get the rectangle difference rectangle.
getRectDifferences() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
This will get the margin between the annotations "outer" rectangle defined by /Rect and the boundaries of the underlying caret.
getRectDifferences() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will get the margin between the annotations "outer" rectangle defined by /Rect and the border.
getRectDifferences() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will get the differences between the annotations "outer" rectangle defined by /Rect and the border.
getReferencedKey() - Method in class org.apache.pdfbox.pdfparser.xref.FreeXReference
Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
getReferencedKey() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
getReferencedKey() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
getReferencedKey() - Method in interface org.apache.pdfbox.pdfparser.xref.XReferenceEntry
Returns the COSObjectKey of the object, that is described by this crossreference stream entry.
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.text.PDFTextStripperByArea
Get the list of regions that have been setup.
getRegistry() - Method in class org.apache.pdfbox.pdmodel.font.CIDSystemInfo
 
getRegistry() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDSystemInfo
 
getRegistryName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
getRelationship() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Get the relationship between the current document and the target (which may be an intermediate target).
getRenderer() - Method in class org.apache.pdfbox.rendering.PageDrawer
Returns the parent renderer.
getRenderingHints() - Method in class org.apache.pdfbox.printing.PDFPageable
Get the rendering hints.
getRenderingHints() - Method in class org.apache.pdfbox.printing.PDFPrintable
Get the rendering hints.
getRenderingHints() - Method in class org.apache.pdfbox.rendering.PageDrawerParameters
 
getRenderingHints() - Method in class org.apache.pdfbox.rendering.PDFRenderer
Get the rendering hints.
getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the rendering intent.
getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will get the rendering intent.
getRenderingMode() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Get the value of the renderingMode.
getRenderState(RenderDestination) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
 
getRepeat() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Gets whether to repeat the sound indefinitely.
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.
getResourceCache() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Returns the resource cache associated with this document, or null if there is none.
getResourceCache() - Method in class org.apache.pdfbox.pdmodel.PDPage
Returns the resource cache associated with this page, or null if there is none.
getResourceCache() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the resource cache associated with the Resources, or null if there is none.
getResources() - Method in interface org.apache.pdfbox.contentstream.PDContentStream
Returns this stream's resources, if any.
getResources() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
getResources() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
getResources() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
Returns the optional resources of the type3 stream.
getResources() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
This will get the resources for this Form XObject.
getResources() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will get the resources for this pattern.
getResources() - Method in class org.apache.pdfbox.pdmodel.PDPage
A dictionary containing any resources required by the page.
getRevision() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will return the R entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.14.
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.
getRichContents() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
This will retrieve the rich text stream which is displayed in the popup window.
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.
getRichTextValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Get the fields rich text value.
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.graphics.state.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.
getRotateInstance(double, float, float) - Static method in class org.apache.pdfbox.util.Matrix
Convenience method to create a rotated instance.
getRotation() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will get the clockwise rotation in degrees.
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
Returns the rotation angle in degrees by which the page should be rotated clockwise when displayed or printed.
getRotation() - Method in class org.apache.pdfbox.text.TextPosition
This will get the rotation of the page that the text is located in.
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).
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.
getScaleX() - Method in class org.apache.pdfbox.util.Matrix
Returns the x-scaling element of this matrix.
getScaleY() - Method in class org.apache.pdfbox.util.Matrix
Returns the y-scaling element of this matrix.
getScalingFactorX() - Method in class org.apache.pdfbox.util.Matrix
Returns the x-scaling factor of this matrix.
getScalingFactorY() - Method in class org.apache.pdfbox.util.Matrix
Returns the y-scaling factor of this matrix.
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).
getScriptingHandler() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set a handler to support JavaScript actions in the form.
getSecondColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.FreeXReference
Returns the value for the second column of the crossreference stream entry.
getSecondColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns the value for the second column of the crossreference stream entry.
getSecondColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the value for the second column of the crossreference stream entry.
getSecondColumnValue() - Method in interface org.apache.pdfbox.pdfparser.xref.XReferenceEntry
Returns the value for the second column of the crossreference stream entry.
getSecurityHandler() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns the security handler specified in the dictionary's Filter entry.
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.
getSeedValueCertificate() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) A certificate seed value dictionary containing information about the certificate to be used when signing.
getSelectedExportValues() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton
This will get the selected export values.
getSelectedIndex() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton
This will get the selected index.
getSelectedOptionsIndex() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will get the indices of the selected options - the 'I' key.
getSeparateByBeads() - Method in class org.apache.pdfbox.text.PDFTextStripper
This will tell if the text stripper should separate by beads.
getSerifStyle() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getSetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the 'SetFf' entry of the FDF field dictionary.
getSetWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will get the 'SetF' entry of the FDF field dictionary.
getShading(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getShading() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPattern
This will get the shading resources for this pattern.
getShading() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingPaint
 
getShading(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the shading resource with the given name, or null if none exists.
getShading(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the shading resource for the given indirect object, if it is in the cache.
getShadingNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the shading resources, if any.
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will return the shading type.
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
 
getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
 
getShearX() - Method in class org.apache.pdfbox.util.Matrix
Returns the x-shear element of this matrix.
getShearY() - Method in class org.apache.pdfbox.util.Matrix
Returns the y-shear element of this matrix.
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.pdmodel.PDDocument
Retrieve all signature dictionaries from the document.
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() - Method in class org.apache.pdfbox.pdmodel.PDDocument
Retrieve all signature fields from the document.
getSignatureReason() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
gets reason of signing
getSignatureRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets SignatureRectangle
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
Return the signed content of the document.
getSignedContent(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
Return the signed content of the document.
getSignerLocation() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
Gets signer location
getSignerName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
 
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.
getSmoothness() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
get the value of the smoothness property.
getSmoothnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the smothness tolerance.
getSoftMask() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns the Soft Mask Image XObject associated with this image, or null if there is none.
getSoftMask() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
Returns the soft mask stored in the COS dictionary
getSoftMask() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
returns the current softmask
getSortByPosition() - Method in class org.apache.pdfbox.text.PDFTextStripper
This will tell if the text stripper should sort the text tokens before writing to the stream.
getSound() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Gets the sound object.
getSourceDocument() - Method in class org.apache.pdfbox.multipdf.Splitter
The source PDF document.
getSourceRegion() - Method in class org.apache.pdfbox.filter.DecodeOptions
When decoding an image, the part of the image that should be decoded, or null if the entire image is needed.
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.
getSpacingTolerance() - Method in class org.apache.pdfbox.text.PDFTextStripper
Get the current space width-based tolerance value that is being used to estimate where spaces in text should be added.
getStack() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
Returns the stack used by this execution context.
getStandard14AFM() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the AFM if this is a Standard 14 font.
getStandard14Width(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the glyph width from the AFM if this is a Standard 14 font.
getStandard14Width(int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
getStandard14Width(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
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.text.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.multipdf.PageExtractor
Gets the first page number to be extracted.
getStartPage() - Method in class org.apache.pdfbox.text.PDFTextStripper
This is the page that the text extraction will start on.
getStartPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
getStartPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.
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.
getStartPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
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.
getState() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
This will retrieve the annotation state.
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.fdf.FDFAnnotationText
This will retrieve the annotation state model.
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.
getStdCryptFilterDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns the standard crypt filter.
getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
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.
getStencilImage(Paint) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns an ARGB image filled with the given paint and using this image as a mask.
getStencilImage(Paint) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns an ARGB image filled with the given paint and using this image as a mask.
getStencilImage(Paint) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
getStream() - Method in class org.apache.pdfbox.pdfparser.PDFXRefStream
Returns the stream of the XRef.
getStream() - Method in class org.apache.pdfbox.pdmodel.graphics.PDXObject
Returns the stream.
getStreamCacheCreateFunction() - Method in class org.apache.pdfbox.multipdf.Splitter
 
getStreamFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns the name of the filter which is used for de/encrypting streams.
getStreamIndex() - Method in class org.apache.pdfbox.cos.COSObjectKey
The index within a compressed object 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 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 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 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 string.
getString() - Method in class org.apache.pdfbox.cos.COSString
Returns the content of this string as a PDF text string.
getString(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Gets a string attribute value.
getString(byte) - Static method in class org.apache.pdfbox.util.Hex
Returns a hex string of the given byte.
getString(byte[]) - Static method in class org.apache.pdfbox.util.Hex
Returns a hex string of the given byte array.
getStringFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns the name of the filter which is used for de/encrypting strings.
getStringOrStream(COSBase) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get a text or text stream.
getStringOrStream(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Get a text as text stream.
getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the width of the given Unicode string.
getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getStrokeVariation() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getStrokingAlphaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the stroking alpha constant.
getStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Returns the stroking color.
getStrokingColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Returns the stroking color space.
getStrokingJavaComposite() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
getStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the overprint control.
getStructParent() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Returns 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.form.PDFormXObject
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
Resturns the PDF template Structure
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, or null if none exists.
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.
getStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
getSubDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
Returns the entry as an appearance subdictionary.
getSubFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
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.interactive.digitalsignature.PDSeedValueCertificate
Returns list of byte arrays that contains DER-encoded X.509v3 certificates
getSubject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the subject of the document.
getSubjectDN() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Returns list of maps that contains subject distinguished names like [(cn: John Doe, o: Doe), (cn: John Smith)] both keys are typically of the form 'cn', 'o', 'email', '2.5.4.43'; and values are text strings.
getSubsampling(PDImage, AffineTransform) - Method in class org.apache.pdfbox.rendering.PageDrawer
Calculates the subsampling frequency for a given PDImage based on the current transformation and its calculated transform.
getSubsamplingOffsetX() - Method in class org.apache.pdfbox.filter.DecodeOptions
When decoding an image, the horizontal offset for subsampling
getSubsamplingOffsetY() - Method in class org.apache.pdfbox.filter.DecodeOptions
When decoding an image, the vertical offset for subsampling
getSubsamplingX() - Method in class org.apache.pdfbox.filter.DecodeOptions
When decoding an image, the number of columns to advance in the source for every pixel decoded.
getSubsamplingY() - Method in class org.apache.pdfbox.filter.DecodeOptions
When decoding an image, the number of rows to advance in the source for every pixel decoded.
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.
getSubType() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Returns the subtype of the soft mask (Alpha, Luminosity) - S entry
getSubType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.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 interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the suffix for this image type, e.g.
getSuffix() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
This will get the suffix for this image type, e.g.
getSuffix() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
Returns the suffix for this image type, e.g.
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.
getSupplement() - Method in class org.apache.pdfbox.pdmodel.font.CIDSystemInfo
 
getSupplement() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDSystemInfo
 
getSuppressDuplicateOverlappingText() - Method in class org.apache.pdfbox.text.PDFTextStripper
 
getSymbol() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
This will retrieve the symbol that shall be associated with the caret.
getSymbolicFlag() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns the value of the symbolic flag, allowing for the fact that the result may be indeterminate.
getSynchronous() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Gets the synchronous flag.
getT() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
The annotation or annotations to be hidden or shown
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.
getTargetDirectory() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
Get the target directory.
getTargetDirectory() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Get the target directory.
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.
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.
getText(PDDocument) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will return the text of a document.
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 RGB 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.text.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.state.PDExtendedGraphicsState
/** This will get the text knockout flag.
getTextLineMatrix() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
getTextLineMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
getTextMatrix() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
getTextMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
getTextMatrix() - Method in class org.apache.pdfbox.text.TextPosition
The matrix containing the starting text position and scaling.
getTextState() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will get the graphics text state.
getThirdColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.FreeXReference
Returns the value for the third column of the crossreference stream entry.
getThirdColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns the value for the third column of the crossreference stream entry.
getThirdColumnValue() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns the value for the third column of the crossreference stream entry.
getThirdColumnValue() - Method in interface org.apache.pdfbox.pdfparser.xref.XReferenceEntry
Returns the value for the third column of the crossreference stream entry.
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
Returns the document's article threads.
getTilingType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
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.
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.
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).
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.PDListBox
This will get the top index "TI" value.
getTopLevelObjects() - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
Returns all COSBases, that must be added to the document's top level container.
getToUnicodeCMap() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Get the /ToUnicode CMap.
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.
getTrailerCount() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns the count of trailers.
getTransfer() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the transfer function of the /TR dictionary.
getTransfer() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will get the transfer function.
getTransfer2() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will get the transfer function of the /TR2 dictionary.
getTransferFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Returns the transfer function.
getTransform() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getTransition() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
getTranslateInstance(float, float) - Static method in class org.apache.pdfbox.util.Matrix
Convenience method to create a translating instance.
getTranslateX() - Method in class org.apache.pdfbox.util.Matrix
Returns the x-translation element of this matrix.
getTranslateY() - Method in class org.apache.pdfbox.util.Matrix
Returns the y-translation element of this matrix.
getTransparency() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingPaint
 
getTransparency() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingPaint
 
getTrapped() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will get the trapped value for the document.
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.
getTrueTypeFont() - Method in class org.apache.pdfbox.pdmodel.font.CIDFontMapping
Returns a TrueType font when isCIDFont() is true, otherwise null.
getTrueTypeFont(String, PDFontDescriptor) - Method in interface org.apache.pdfbox.pdmodel.font.FontMapper
Finds a TrueType font with the given PostScript name, or a suitable substitute, or null.
getTrueTypeFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
Returns the embedded or substituted TrueType font.
getTrueTypeFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Returns the embedded or substituted TrueType font.
getTrustedMode() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
If true, the application was in trusted mode when signing took place.
getType() - Method in class org.apache.pdfbox.pdfparser.xref.AbstractXReference
Returns the XReferenceType of this crossreference stream entry.
getType() - Method in interface org.apache.pdfbox.pdfparser.xref.XReferenceEntry
Returns the XReferenceType of this crossreference stream entry.
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.PDAbstractPattern
This will return the paint type.
getType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will return the type.
getType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
getType1Font() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
Returns the embedded or substituted Type 1 font, or null if there is none.
getType2CharString(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
Returns the Type 2 charstring for the given CID, or null if the substituted font does not contain Type 2 charstrings.
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.
getUnderlyingColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Returns the underlying color space, if this is an uncolored tiling pattern, otherwise null.
getUnicode() - Method in class org.apache.pdfbox.text.TextPosition
Return the string of characters stored in this object.
getUnits() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the label for the units.
getUpdateState() - Method in class org.apache.pdfbox.cos.COSArray
Returns the current COSUpdateState of this COSArray.
getUpdateState() - Method in class org.apache.pdfbox.cos.COSDictionary
Returns the current COSUpdateState of this COSDictionary.
getUpdateState() - Method in class org.apache.pdfbox.cos.COSObject
Returns the current COSUpdateState of this COSObject.
getUpdateState() - Method in interface org.apache.pdfbox.cos.COSUpdateInfo
Returns the current COSUpdateState of this COSUpdateInfo.
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 number 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.PDActionURI
This will get the uniform resource identifier to resolve.
getURI() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Returns the document-level URI.
getURL() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
returns String of the URL
getURL() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Returns the URL.
getURLType() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
A name indicating the usage of the URL entry.
getUserEncryptionKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will get the UE entry in the standard encryption dictionary.
getUserKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will get the U entry in the standard encryption dictionary.
getUserPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Returns the user password.
getUserPassword(byte[], byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Get the user password based on the owner password.
getUserUnit() - Method in class org.apache.pdfbox.pdmodel.PDPage
Get the user unit.
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.
getValue() - Method in class org.apache.pdfbox.cos.COSBoolean
This will get the value that this object wraps.
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 get the value for the field.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Returns the selected value.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Returns the selected values, or an empty List.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Returns the COSBase value of the "V" entry.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Returns the signature contained in this field.
getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
Returns the value of this field, or an empty 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.
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
 
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
 
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Returns a string representation of the "V" entry, or an empty string.
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Returns a string representation of the "V" entry, or an empty string.
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
 
getValueAsString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
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.
getVersion() - Method in class org.apache.pdfbox.cos.COSDocument
This will get the version extracted from the header of this PDF document.
getVersion() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will return the V entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.13.
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.PDDocument
Returns the PDF specification version this document conforms to.
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.util.Version
Returns the version of PDFBox.
getVerticalDisplacementVectorY(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
Returns the y-component of the vertical displacement vector (w1).
getVertices() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
This will get the coordinates of the vertices.
getVertices() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will get the coordinates of the the vertices.
getVertices() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will retrieve the numbers that shall represent the alternating horizontal and vertical coordinates.
getVertices() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
This will retrieve the numbers that shall represent the alternating horizontal and vertical coordinates.
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.
getViewports() - Method in class org.apache.pdfbox.pdmodel.PDPage
Get the viewports.
getVisibilityPolicy() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
Get the visibility policy name.
getVisibleSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
returns visible signature configuration object
getVisuallyOrderedUnicode() - Method in class org.apache.pdfbox.text.TextPosition
Same as TextPosition.getUnicode() except that returned text is ensured to be visually ordered (i.e.
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.
getVolume() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Sets the volume.
getWC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
This will get a JavaScript action to be performed before closing a document.
getWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
getWeightClass() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
Returns the usWeightClass field of the "OS/2" table, or -1.
getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
This will return the whitepoint tristimulus.
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 FDF field dictionary.
getWidgets() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Returns the widget annotations associated with this field.
getWidgets() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
 
getWidgets() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
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(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
getWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
getWidth(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the advance width of the given character, in glyph space.
getWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType3CharProc
Get the width from a type3 charproc stream.
getWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getWidth() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns the width of this image, or -1 if one has not been set.
getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.text.TextPosition
This will get the width of the string when page rotation adjusted coordinates are used.
getWidthDirAdj() - Method in class org.apache.pdfbox.text.TextPosition
This will get the width of the string when text direction adjusted coordinates are used.
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
getWidthFromFont(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns the width of a glyph in the embedded font file.
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
getWidthFromFont(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
getWidthOfSpace() - Method in class org.apache.pdfbox.text.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.PDActionLaunch
This will get a dictionary containing Windows-specific launch parameters.
getWordSeparator() - Method in class org.apache.pdfbox.text.PDFTextStripper
This will get the word separator.
getWordSpacing() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Get the value of the wordSpacing.
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
Returns 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.text.TextPosition
This will get the page rotation adjusted x position of the character.
getX() - Method in class org.apache.pdfbox.util.Vector
Returns the x magnitude.
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.text.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.PDPanoseClassification
 
getXObject(COSObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
getXObject(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the XObject resource with the given name, or null if none exists.
getXObject(COSObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Returns the XObject resource for the given indirect object, if it is in the cache.
getXObjectNames() - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns the names of the XObject resources, if any.
getXRefEntries() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will get the xref entries.
getXRefRanges(List<XReferenceEntry>) - 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.
getXrefType() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Returns the XRefTxpe of the resolved trailer.
getXScale() - Method in class org.apache.pdfbox.text.TextPosition
This will get the X scaling factor.
getXStep() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will return the XStep value.
getY() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Returns the y value of the tristimulus.
getY() - Method in class org.apache.pdfbox.text.TextPosition
This will get the page rotation adjusted x position of the character.
getY() - Method in class org.apache.pdfbox.util.Vector
Returns the y magnitude.
getyAxis() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
getYDirAdj() - Method in class org.apache.pdfbox.text.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.
getYScale() - Method in class org.apache.pdfbox.text.TextPosition
This will get the Y scaling factor.
getYStep() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will return the YStep value.
getZ() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Returns the z value of the tristimulus.
getZapfDingbats() - Static method in class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Returns the Zapf Dingbats glyph list.
getZoom() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
Get the zoom value.
GLYPH_ORIENTATION_VERTICAL_180_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 180°
GLYPH_ORIENTATION_VERTICAL_270_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 270°
GLYPH_ORIENTATION_VERTICAL_360_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 360°
GLYPH_ORIENTATION_VERTICAL_90_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 90°
GLYPH_ORIENTATION_VERTICAL_AUTO - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: Auto
GLYPH_ORIENTATION_VERTICAL_MINUS_180_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: -180°
GLYPH_ORIENTATION_VERTICAL_MINUS_90_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: -90°
GLYPH_ORIENTATION_VERTICAL_ZERO_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
GlyphOrientationVertical: 0°
GlyphList - Class in org.apache.pdfbox.pdmodel.font.encoding
PostScript glyph list, maps glyph names to sequences of Unicode characters.
GlyphList(InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Creates a new GlyphList from a glyph list file.
GlyphList(GlyphList, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Creates a new GlyphList from multiple glyph list files.
glyphList - Variable in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
GraphicsOperatorProcessor - Class in org.apache.pdfbox.contentstream.operator.graphics
Base class for graphics operators.
GraphicsOperatorProcessor(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.GraphicsOperatorProcessor
 
GROUP - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
GTS_PDFA1 - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
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
HARD_LIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
HARD_LIGHT - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
hasAnyRevision3PermissionSet() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Indicates if any revision 3 access permission is set or not.
hasCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will retrieve whether the text specified by the /Contents or /RC entries shall be shown as a caption in the appearance of the line.
hasChildren() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
 
hasColorSpace(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Returns true if the given color space name exists in these resources.
hasContents() - Method in class org.apache.pdfbox.pdmodel.PDPage
Returns true if this page has one or more content streams.
hasData() - Method in class org.apache.pdfbox.cos.COSStream
Indicates whether the stream contains any data or not.
hasExplicitWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
hasExplicitWidth(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns true if the Font dictionary specifies an explicit width for the given glyph.
hasExplicitWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
hasExplicitWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
hasGlyph(String) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns true if the font contains the character with the given name.
hasGlyph(String) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
hasGlyph(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
hasGlyph(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
hasGlyph(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
hasGlyph(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
hasGlyph(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDVectorFont
Returns true if this font contains a glyph for the given character code in a PDF.
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.COSBoolean
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.COSObjectKey
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.documentinterchange.logicalstructure.PDUserProperty
 
hashCode() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
hashCode() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
hashCode() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
hashCode() - Method in class org.apache.pdfbox.text.TextPosition
 
hashCode() - Method in class org.apache.pdfbox.util.Matrix
 
hasHybridXRef() - Method in class org.apache.pdfbox.cos.COSDocument
Determines if the pdf has hybrid cross references, both plain tables and streams.
hasMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Returns true if the missing widths entry is present in the font descriptor.
hasProtectionPolicy() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Returns whether a protection policy has been set.
hasSecurityHandler() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Returns true if the security handler specified in the dictionary's Filter is available.
hasWidths() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Returns true if widths are present in the font descriptor.
hasXFA() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell if the AcroForm has XFA content.
HEADERS - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
HEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
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
HELV - Static variable in class org.apache.pdfbox.cos.COSName
 
Hex - Class in org.apache.pdfbox.util
Utility functions for hex encoding.
HIDE_MENUBAR - Static variable in class org.apache.pdfbox.cos.COSName
 
HIDE_TOOLBAR - Static variable in class org.apache.pdfbox.cos.COSName
 
HIDE_WINDOWUI - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
HUE - Static variable in class org.apache.pdfbox.cos.COSName
 
HUE - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Non-separable blend modes as defined in the PDF specification

I

I - Static variable in class org.apache.pdfbox.cos.COSName
 
IC - Static variable in class org.apache.pdfbox.cos.COSName
 
ICCBASED - Static variable in class org.apache.pdfbox.cos.COSName
 
ICOSParser - Interface in org.apache.pdfbox.cos
 
ICOSVisitor - Interface in org.apache.pdfbox.cos
An interface for visiting a PDF document at the type (COS) level.
ID - Static variable in class org.apache.pdfbox.cos.COSName
 
ID_TREE - Static variable in class org.apache.pdfbox.cos.COSName
 
IDENTITY - Static variable in class org.apache.pdfbox.cos.COSName
 
IDENTITY_H - Static variable in class org.apache.pdfbox.cos.COSName
 
IDENTITY_V - Static variable in class org.apache.pdfbox.cos.COSName
 
IF - Static variable in class org.apache.pdfbox.cos.COSName
 
ILLUSTRATOR - Static variable in class org.apache.pdfbox.cos.COSName
 
IM - Static variable in class org.apache.pdfbox.cos.COSName
 
IMAGE - Static variable in class org.apache.pdfbox.cos.COSName
 
IMAGE_MASK - Static variable in class org.apache.pdfbox.cos.COSName
 
imageSizeInPercents(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
ImageType - Enum in org.apache.pdfbox.rendering
Image type for rendering.
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.PDTerminalField
 
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.multipdf.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.multipdf.LayerUtility
Imports a page from some PDF file as a Form XObject so it can be placed on another page in the target document.
importXMPMetadata(byte[]) - Method in class org.apache.pdfbox.pdmodel.common.PDMetadata
Import an XMP stream into the PDF document.
increaseLevel() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Increase the level.
incrementRevisionNumber() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Increments th revision number.
INDEX - Static variable in class org.apache.pdfbox.cos.COSName
 
INDEX - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Index
INDEXED - Static variable in class org.apache.pdfbox.cos.COSName
 
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
indexOf(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Returns the index of the given page, or -1 if it does not exist.
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
 
init() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
Lazy load the ICC profile, because it's slow.
initialOffset(float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
initialParse() - Method in class org.apache.pdfbox.pdfparser.PDFParser
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.
initialParseDone - Variable in class org.apache.pdfbox.pdfparser.COSParser
 
injectAppearanceStreams(PDStream, PDStream, PDStream, COSName, COSName, COSName, PDVisibleSignDesigner) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
injects appearance streams
injectAppearanceStreams(PDStream, PDStream, PDStream, COSName, COSName, COSName, PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
injectProcSetArray(PDFormXObject, PDPage, PDResources, PDResources, PDResources, COSArray) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Inject procSetArray
injectProcSetArray(PDFormXObject, PDPage, PDResources, PDResources, PDResources, COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
INKLIST - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
insertAfter(PDPage, PDPage) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Insert a page after another page within a page tree.
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.
insertBefore(PDPage, PDPage) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Insert a page before another page within a page tree.
insertInnerFormToHolderResources(PDFormXObject, PDResources) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
Insert given from as inner form.
insertInnerFormToHolderResources(PDFormXObject, 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 single sibling after this node.
insertSiblingBefore(PDOutlineItem) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Insert a single sibling before this node.
INSTANCE - Static variable in class org.apache.pdfbox.filter.FilterFactory
Singleton instance.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlerFactory
Singleton instance
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.MacExpertEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.MacOSRomanEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.MacRomanEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.StandardEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.SymbolEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.WinAnsiEncoding
Singleton instance of this class.
INSTANCE - Static variable in class org.apache.pdfbox.pdmodel.font.encoding.ZapfDingbatsEncoding
Singleton instance of this class.
instance() - Static method in class org.apache.pdfbox.pdmodel.font.FontMappers
Returns the singleton FontMapper instance.
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.PDDeviceGray
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.
INTENT - Static variable in class org.apache.pdfbox.cos.COSName
 
INTERIOR_COLOR_STYLES - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
Line ending styles where there is an interior color.
INTERPOLATE - Static variable in class org.apache.pdfbox.cos.COSName
 
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 ).
intersectClippingPath(GeneralPath) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Modify the current clipping path by intersecting it with the given path.
intersectClippingPath(Area) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Modify the current clipping path by intersecting it with the given path.
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.
intValue() - Method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
Returns the integer value of this mode, as used in a PDF file.
InvalidPasswordException - Exception in org.apache.pdfbox.pdmodel.encryption
Indicates that an invalid password was supplied.
inverted - Variable in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
name-to-code map.
IRT - Static variable in class org.apache.pdfbox.cos.COSName
 
isAcceptingUpdates() - Method in class org.apache.pdfbox.cos.COSDocumentState
Returns true, if the document´s COSDocumentState.parsing is completed and it may be updated.
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.state.PDGraphicsState
get the value of the stroke alpha source property.
isAppendOnly() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Determines if AppendOnly is set.
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.
isCIDFont() - Method in class org.apache.pdfbox.pdmodel.font.CIDFontMapping
Returns true if this is a CID font.
isClip() - Method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
Returns true if this mode clips text.
isClosed() - Method in class org.apache.pdfbox.cos.COSDocument
Returns true if this document has been closed.
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 ).
isComb() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
isCombo() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Determines if Combo is set.
isCommitOnSelChange() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Determines if CommitOnSelChange is set.
isCompress() - Method in class org.apache.pdfbox.pdfwriter.compress.CompressParameters
Indicates whether the creation of compressed object streams is enabled or not.
isCompress() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
Returns true, if the resulting document shall be compressed.
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
isDamaged() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns true if the embedded font file is damaged.
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
isDamaged() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
isDecrypted() - Method in class org.apache.pdfbox.cos.COSDocument
Indicates if a encrypted pdf is already decrypted after parsing.
isDecryptMetadata() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Returns true if meta data is to be decrypted.
isDereferenced() - Method in class org.apache.pdfbox.cos.COSObject
Returns true, if the hereby referenced COSBase has already been parsed and loaded.
isDiacritic() - Method in class org.apache.pdfbox.text.TextPosition
 
isDigestMethodRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isDigit() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte is a digit or not.
isDigit(int) - Static method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the given value is a digit or not.
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.
isDoNotSpellCheck() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Determines if DoNotSpellCheck is set.
isEdit() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDComboBox
Determines if Edit is set.
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
 
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
 
isEmbedded() - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
Returns true if the font file is embedded in the PDF.
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
isEmbedded() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
Returns true if the font file is embedded in the PDF.
isEmpty() - Method in class org.apache.pdfbox.cos.COSName
Returns true if the name is the empty string.
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.
isEmpty() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns true if the image has no data.
isEmpty() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
isEmpty() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
isEmpty() - Method in class org.apache.pdfbox.util.SmallMap
 
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.PDCryptFilterDictionary
Will get the EncryptMetaData dictionary info.
isEncryptMetaData() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Will get the EncryptMetaData dictionary info.
isEndOfName(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Determine if a character terminates a PDF name.
isEOF() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the end of the data is reached.
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.
isFallback() - Method in class org.apache.pdfbox.pdmodel.font.FontMapping
Returns true if the mapped font is a fallback, i.e.
isFD() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will return the value indication if the denominator of the fractional value is reduced/truncated .
isFileSelect() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
isFill() - Method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
Returns true if this mode fills text.
isFilterRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isFilterSubsampled() - Method in class org.apache.pdfbox.filter.DecodeOptions
Flag used by the filter to specify if it performed subsampling.
isFixedPitch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isFlyAreaOpaque() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
isFontSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Internal implementation of isSymbolic, allowing for the fact that the result may be indeterminate.
isFontSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
isForceBold() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isGroupEnabled(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Indicates whether at least one optional content group with this name is enabled.
isGroupEnabled(PDOptionalContentGroup) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Indicates whether an optional content group is enabled.
isGroupEnabled(PDOptionalContentGroup) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Indicates whether an optional content group is enabled.
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.multipdf.PDFMergerUtility
Indicates if acroform errors are ignored or not.
isImageXObject(COSName) - Method in class org.apache.pdfbox.pdmodel.PDResources
Tells whether the XObject resource with the given name is an image.
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.
isIsolated() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Returns true if this group is isolated.
isIssuerRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
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.
isKeyUsageRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
isKnockout() - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Returns true if this group is a knockout.
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.COSParser
Return true if parser is lenient.
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.
isLockedContents() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the LockedContents flag.
isLockedContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Get the LockedContents 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.PDTextField
 
isMultiSelect() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Determines if MultiSelect is set.
isNChannel() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Returns true if this color space has the NChannel subtype.
isNChannel() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Returns true if this is an NChannel (PDF 1.6) color space.
isNeedToBeUpdated() - Method in interface org.apache.pdfbox.cos.COSUpdateInfo
Get the update state for the COSWriter.
isNodeOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
 
isNodeOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
 
isNoExport() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
isNonStrokingOverprint() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
get the value of the non stroking overprint property.
isNonSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isNonZeroBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
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.
isObjectNull() - Method in class org.apache.pdfbox.cos.COSObject
Indicates if the referenced object is present or not.
isObjectStream() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns true, if the referenced object is an object stream.
isOIDRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
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.state.PDGraphicsState
get the value of the overprint property.
isOverwrite() - Method in enum org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode
 
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.
isOwnerPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
This will tell if the access permission corresponds to owner access permission (no restriction).
isPassword() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
isPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns true if this color value is a pattern.
isPreferAES() - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
Tell whether AES encryption is preferred when several encryption methods are available for the chosen key length.
isPrepend() - Method in enum org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode
 
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.
isPushButton() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Determines if push button bit is set.
isRadioButton() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Determines if radio button bit is set.
isRadiosInUnison() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton
 
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
 
isRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
isRichText() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
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.
isSeparableBlendMode() - Method in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Determines if the blend mode is a separable blend mode.
isSerif() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSignaturesExist() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Determines if SignaturesExist is set.
isSmallCap() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that checks the flag bit.
isSort() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Determines if Sort is set.
isSpace() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte is a space or not.
isSpace(int) - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the given value is a space or not.
isSpecified(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
Is the attribute with the given name specified in this attribute object?
isStandard14() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns true if this font is one of the "Standard 14" fonts and receives special handling.
isStandard14() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
isStandard14() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
isStandard14() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
isStencil() - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Returns true if the image is a stencil mask.
isStencil() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
isStencil() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
isStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
Returns true if this entry is an appearance stream.
isString(char[]) - Method in class org.apache.pdfbox.pdfparser.COSParser
Checks if the given string can be found at the current offset.
isStroke() - Method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
Returns true if this mode strokes text.
isStrokeAdjustment() - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Get the value of the stroke adjustment parameter.
isSubDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
Returns true if this entry is an appearance subdictionary.
isSubFilterRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
 
isSubjectDNRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
isSubjectRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
isSubsamplingAllowed() - Method in class org.apache.pdfbox.printing.PDFPageable
Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale.
isSubsamplingAllowed() - Method in class org.apache.pdfbox.printing.PDFPrintable
Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale.
isSubsamplingAllowed() - Method in class org.apache.pdfbox.rendering.PageDrawerParameters
Returns whether to allow subsampling of images.
isSubsamplingAllowed() - Method in class org.apache.pdfbox.rendering.PDFRenderer
Value indicating if the renderer is allowed to subsample images before drawing, according to image dimensions and requested scale.
ISSUER - Static variable in class org.apache.pdfbox.cos.COSName
 
isSuppressDuplicateOverlappingText() - Method in class org.apache.pdfbox.text.PDFMarkedContentExtractor
 
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.
isSymbolic() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Returns true if the font is a symbolic (that is, it does not use the Adobe Standard Roman character set).
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?
isUpdated() - Method in class org.apache.pdfbox.cos.COSUpdateState
Returns the actual COSUpdateState.updated state of the managed COSUpdateState.updateInfo.
isURLRequired() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
 
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.
isValid() - Method in class org.apache.pdfbox.cos.COSInteger
Indicates whether this instance represents a valid value.
isVertical() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns true if the font uses vertical writing mode.
isVertical() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
isVertical() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
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
 
isWhitePoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
Tests if the current point is the white point.
isWhitespace() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if the next byte is whitespace or not.
isWhitespace(int) - Static method in class org.apache.pdfbox.pdfparser.BaseParser
This will tell if a character is whitespace or not.
isXRefStream() - Method in class org.apache.pdfbox.cos.COSDocument
Determines if the trailer is a XRef stream or not.
IT - Static variable in class org.apache.pdfbox.cos.COSName
 
IT_FREE_TEXT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
A plain free-text annotation, also known as a text box comment.
IT_FREE_TEXT_CALLOUT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
A callout, associated with an area on the page through the callout line specified.
IT_FREE_TEXT_TYPE_WRITER - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
The annotation is intended to function as a click-to-type or typewriter object.
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
 
items - Variable in class org.apache.pdfbox.cos.COSDictionary
The name-value pairs of this dictionary.
IterativeMergeSort - Class in org.apache.pdfbox.util
This class provides an iterative (bottom-up) implementation of the MergeSort algorithm for any generic Java object which implements a Comparator.
iterator() - Method in class org.apache.pdfbox.cos.COSArray
Get access to the list.
iterator() - Method in class org.apache.pdfbox.cos.COSIncrement
Return an iterator for the determined COSIncrement.objects contained in this COSIncrement.
iterator() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
iterator() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDFieldTree
Returns an iterator which walks all fields in the tree, in order.
iterator() - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Returns an iterator which walks all pages in the tree, in order.
IX - Static variable in class org.apache.pdfbox.cos.COSName
 

J

J - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
JAVA_SCRIPT - Static variable in class org.apache.pdfbox.cos.COSName
 
JBIG2_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
JBIG2_GLOBALS - Static variable in class org.apache.pdfbox.cos.COSName
 
JPEGFactory - Class in org.apache.pdfbox.pdmodel.graphics.image
Factory for creating a PDImageXObject containing a JPEG compressed image.
JPX_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
JPXFilter - Class in org.apache.pdfbox.filter
Decompress data encoded using the wavelet-based JPEG 2000 standard, reproducing the original data.
JPXFilter() - Constructor for class org.apache.pdfbox.filter.JPXFilter
 
JS - Static variable in class org.apache.pdfbox.cos.COSName
 

K

K - Static variable in class org.apache.pdfbox.cos.COSName
 
KEY_USAGE - Static variable in class org.apache.pdfbox.cos.COSName
 
keyboard(PDActionJavaScript, String) - Method in interface org.apache.pdfbox.pdmodel.interactive.form.ScriptingHandler
Handle the fields keyboard event action.
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
keySet() - Method in class org.apache.pdfbox.util.SmallMap
Returns a set view of the keys contained in this map.
KEYWORDS - Static variable in class org.apache.pdfbox.cos.COSName
 
KIDS - Static variable in class org.apache.pdfbox.cos.COSName
 

L

L - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
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
 
LAST - Static variable in class org.apache.pdfbox.cos.COSName
 
LAST_CHAR - Static variable in class org.apache.pdfbox.cos.COSName
 
LAST_MODIFIED - Static variable in class org.apache.pdfbox.cos.COSName
 
lastIndexOf(char[], byte[], int) - Method in class org.apache.pdfbox.pdfparser.COSParser
Searches last appearance of pattern within buffer.
lastIndexOf(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
LayerUtility - Class in org.apache.pdfbox.multipdf
This class allows to import pages as Form XObjects into a document and use them to create layers (optional content groups).
LayerUtility(PDDocument) - Constructor for class org.apache.pdfbox.multipdf.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
 
LE - Static variable in class org.apache.pdfbox.cos.COSName
 
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 reversed 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
 
LEGACY_FILL_NON_ZERO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
LegacyFillNonZeroRule - Class in org.apache.pdfbox.contentstream.operator.graphics
F Fill path using non zero winding rule.
LegacyFillNonZeroRule(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.LegacyFillNonZeroRule
 
LEGAL - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of U.S.
LEGAL_ATTESTATION - Static variable in class org.apache.pdfbox.cos.COSName
 
LENGTH - Static variable in class org.apache.pdfbox.cos.COSName
 
LENGTH - Static variable in class org.apache.pdfbox.pdmodel.font.PDPanose
Length.
LENGTH - Static variable in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
Length.
LENGTH1 - Static variable in class org.apache.pdfbox.cos.COSName
 
LENGTH2 - Static variable in class org.apache.pdfbox.cos.COSName
 
LENGTH3 - Static variable in class org.apache.pdfbox.cos.COSName
 
LETTER - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of U.S.
LF - Static variable in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
Line feed character.
LI - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
LI
LIGHTEN - Static variable in class org.apache.pdfbox.cos.COSName
 
LIGHTEN - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
LIMITS - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
LINE_SEPARATOR - Static variable in class org.apache.pdfbox.text.PDFTextStripper
The platform's line separator.
LINE_TO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
LINEARIZED - Static variable in class org.apache.pdfbox.cos.COSName
 
LineTo - Class in org.apache.pdfbox.contentstream.operator.graphics
l Append straight line segment to path.
LineTo(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.LineTo
 
lineTo(float, float) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Draws a line from the current point to (x,y).
lineTo(float, float) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
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
 
LL - Static variable in class org.apache.pdfbox.cos.COSName
 
LLE - Static variable in class org.apache.pdfbox.cos.COSName
 
LLO - Static variable in class org.apache.pdfbox.cos.COSName
 
load(File) - Static method in class org.apache.pdfbox.pdfparser.PDFParser
Deprecated.
use loadPDF(File) instead
load(File, String) - Static method in class org.apache.pdfbox.pdfparser.PDFParser
Deprecated.
load(PDDocument, File, Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Loads a TTF to be embedded into a document as a simple font.
load(PDDocument, InputStream, Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Loads a TTF to be embedded into a document as a simple font.
load(PDDocument, TrueTypeFont, Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Loads a TTF to be embedded into a document as a simple font.
load(PDDocument, RandomAccessRead, Encoding) - Static method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Loads a TTF to be embedded into a document as a simple font.
load(PDDocument, File) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded and subset into a document as a Type 0 font.
load(PDDocument, InputStream) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded and subset into a document as a Type 0 font.
load(PDDocument, InputStream, boolean) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a Type 0 font.
load(PDDocument, RandomAccessRead, boolean, boolean) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a Type 0 font.
load(PDDocument, TrueTypeFont, boolean) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a Type 0 font.
Loader - Class in org.apache.pdfbox
Utility methods to load different types of documents
loadFDF(String) - Static method in class org.apache.pdfbox.Loader
This will load a document from a file.
loadFDF(File) - Static method in class org.apache.pdfbox.Loader
This will load a document from a file.
loadFDF(InputStream) - Static method in class org.apache.pdfbox.Loader
This will load a document from an input stream.
loadPDF(byte[]) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(byte[], String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(byte[], String, InputStream, String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(byte[], String, InputStream, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File, String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File, String, InputStream, String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(File, String, InputStream, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead, String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead, String, InputStream, String) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadPDF(RandomAccessRead, String, InputStream, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Static method in class org.apache.pdfbox.Loader
Parses a PDF.
loadVertical(PDDocument, File) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a vertical Type 0 font.
loadVertical(PDDocument, InputStream) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a vertical Type 0 font.
loadVertical(PDDocument, InputStream, boolean) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a vertical Type 0 font.
loadVertical(PDDocument, TrueTypeFont, boolean) - Static method in class org.apache.pdfbox.pdmodel.font.PDType0Font
Loads a TTF to be embedded into a document as a vertical Type 0 font.
loadXFDF(String) - Static method in class org.apache.pdfbox.Loader
This will load a document from a file.
loadXFDF(File) - Static method in class org.apache.pdfbox.Loader
This will load a document from a file.
loadXFDF(InputStream) - Static method in class org.apache.pdfbox.Loader
This will load a document from an input stream.
LOCATION - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
LosslessFactory - Class in org.apache.pdfbox.pdmodel.graphics.image
Factory for creating a PDImageXObject containing a lossless compressed image.
LUMINOSITY - Static variable in class org.apache.pdfbox.cos.COSName
 
LUMINOSITY - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
LW - Static variable in class org.apache.pdfbox.cos.COSName
 
LZW_DECODE - Static variable in class org.apache.pdfbox.cos.COSName
 
LZW_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
M - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
MAC - Static variable in class org.apache.pdfbox.cos.COSName
 
MAC_EXPERT_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
MAC_ROMAN_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
MacExpertEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This is an interface to a text encoder.
MacExpertEncoding() - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.MacExpertEncoding
Constructor.
MacOSRomanEncoding - Class in org.apache.pdfbox.pdmodel.font.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.pdmodel.font.encoding.MacOSRomanEncoding
Constructor.
MacRomanEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This is an interface to a text encoder.
MacRomanEncoding() - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.MacRomanEncoding
Constructor.
MARK_INFO - Static variable in class org.apache.pdfbox.cos.COSName
 
MARKED_CONTENT_POINT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
MARKED_CONTENT_POINT_WITH_PROPS - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
MASK - Static variable in class org.apache.pdfbox.cos.COSName
 
matchPattern(String, List<Pattern>) - Static method in class org.apache.pdfbox.text.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
 
matrix - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingPaint
 
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.
Matrix(float, float, float, float, float, float) - Constructor for class org.apache.pdfbox.util.Matrix
Creates a transformation matrix with the given 6 elements.
Matrix(AffineTransform) - Constructor for class org.apache.pdfbox.util.Matrix
Creates a matrix with the same elements as the given AffineTransform.
MATTE - Static variable in class org.apache.pdfbox.cos.COSName
 
MAX_LEN - Static variable in class org.apache.pdfbox.cos.COSName
 
MAX_WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
 
MCID - Static variable in class org.apache.pdfbox.cos.COSName
 
MDP - Static variable in class org.apache.pdfbox.cos.COSName
 
MEASURE - Static variable in class org.apache.pdfbox.cos.COSName
 
MEDIA_BOX - Static variable in class org.apache.pdfbox.cos.COSName
 
mergeDiacritic(TextPosition) - Method in class org.apache.pdfbox.text.TextPosition
Merge a single character TextPosition into the current object.
mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Merge the list of source documents, saving the result in the destination file.
mergeDocuments(RandomAccessStreamCache.StreamCacheCreateFunction, CompressParameters) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Merge the list of source documents, saving the result in the destination file.
METADATA - Static variable in class org.apache.pdfbox.cos.COSName
 
MINIMUM_SUPPORTED_VERSION - Static variable in class org.apache.pdfbox.pdfwriter.compress.COSWriterCompressionPool
 
MISSING_WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
 
MissingImageReaderException - Exception in org.apache.pdfbox.filter
Thrown when a required JAI ImageReader is missing.
MissingImageReaderException(String) - Constructor for exception org.apache.pdfbox.filter.MissingImageReaderException
 
MissingOperandException - Exception in org.apache.pdfbox.contentstream.operator
Throw when a PDF operator is missing required operands.
MissingOperandException(Operator, List<COSBase>) - Constructor for exception org.apache.pdfbox.contentstream.operator.MissingOperandException
 
MissingResourceException - Exception in org.apache.pdfbox.pdmodel
Thrown when a named resource is missing.
MissingResourceException(String) - Constructor for exception org.apache.pdfbox.pdmodel.MissingResourceException
 
MIX - Static variable in class org.apache.pdfbox.cos.COSName
 
MK - Static variable in class org.apache.pdfbox.cos.COSName
 
ML - Static variable in class org.apache.pdfbox.cos.COSName
 
MM_TYPE1 - Static variable in class org.apache.pdfbox.cos.COSName
 
MOD_DATE - Static variable in class org.apache.pdfbox.cos.COSName
 
MOVE_TEXT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
MOVE_TEXT_SET_LEADING - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
MOVE_TO - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
MoveText - Class in org.apache.pdfbox.contentstream.operator.text
Td: Move text position.
MoveText(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.MoveText
 
MoveTextSetLeading - Class in org.apache.pdfbox.contentstream.operator.text
TD: Move text position and set leading.
MoveTextSetLeading(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.MoveTextSetLeading
 
MoveTo - Class in org.apache.pdfbox.contentstream.operator.graphics
m Begins a new subpath.
MoveTo(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.MoveTo
 
moveTo(float, float) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Starts a new path at (x,y).
moveTo(float, float) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
MULTIPLY - Static variable in class org.apache.pdfbox.cos.COSName
 
MULTIPLY - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
multiply(Matrix) - Method in class org.apache.pdfbox.util.Matrix
This method multiplies this Matrix with the specified other Matrix, storing the product in a new instance.

N

N - Static variable in class org.apache.pdfbox.cos.COSName
 
N - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
NAME - Static variable in class org.apache.pdfbox.cos.COSName
 
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_CHECK - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a check annotation.
NAME_CIRCLE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a circle annotation.
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_CROSS - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a cross annotation.
NAME_CROSS_HAIRS - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a crosshairs annotation.
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_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_RIGHT_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a right arrow annotation.
NAME_RIGHT_POINTER - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a right pointer annotation.
NAME_SOLD - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_STAR - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a star annotation.
NAME_TOP_SECRET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
Constant for the name of a rubber stamp.
NAME_UP_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a crosshairs annotation.
NAME_UP_LEFT_ARROW - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Constant for the name of a crosshairs annotation.
NAMES - Static variable in class org.apache.pdfbox.cos.COSName
 
NAVIGATOR - Static variable in class org.apache.pdfbox.cos.COSName
 
NEED_APPEARANCES - Static variable in class org.apache.pdfbox.cos.COSName
 
NEW_WINDOW - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
newSecurityHandlerForFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlerFactory
Returns a new security handler for the given Filter name, or null none is available.
newSecurityHandlerForPolicy(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlerFactory
Returns a new security handler for the given protection policy, or null none is available.
NEXT - Static variable in class org.apache.pdfbox.cos.COSName
 
NEXT_LINE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NextLine - Class in org.apache.pdfbox.contentstream.operator.text
T*: Move to start of next text line.
NextLine(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.NextLine
 
nextXrefObj(long, XrefTrailerResolver.XRefType) - 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
 
NO_COMPRESSION - Static variable in class org.apache.pdfbox.pdfwriter.compress.CompressParameters
 
NON_EFONT_NO_WARN - Static variable in class org.apache.pdfbox.cos.COSName
 
NON_FULL_SCREEN_PAGE_MODE - Static variable in class org.apache.pdfbox.cos.COSName
 
NON_STROKING_CMYK - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STROKING_COLOR - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STROKING_COLOR_N - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STROKING_COLORSPACE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STROKING_GRAY - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STROKING_RGB - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
NON_STRUCT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
NonStruct
NONE - Static variable in class org.apache.pdfbox.cos.COSName
 
NORMAL - Static variable in class org.apache.pdfbox.cos.COSName
 
NORMAL - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
Separable blend modes as defined in the PDF specification
NormalXReference - Class in org.apache.pdfbox.pdfparser.xref
A class representing a normal reference in a PDF's crossreference stream (PDFXRefStream).
NormalXReference(long, COSObjectKey, COSBase) - Constructor for class org.apache.pdfbox.pdfparser.xref.NormalXReference
Prepares a normal reference for the given COSObject in a PDF's crossreference stream (PDFXRefStream).
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.
NULL_ENTRY - Static variable in class org.apache.pdfbox.pdfparser.xref.FreeXReference
 
NumberFormatUtil - Class in org.apache.pdfbox.util
This class contains methods to format numbers.
NUMS - Static variable in class org.apache.pdfbox.cos.COSName
 

O

O - Static variable in class org.apache.pdfbox.cos.COSName
 
O - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
OBJ - Static variable in class org.apache.pdfbox.cos.COSName
 
OBJ - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The starting object token.
OBJ_MARKER - Static variable in class org.apache.pdfbox.pdfparser.COSParser
obj-marker.
OBJ_STM - Static variable in class org.apache.pdfbox.cos.COSName
 
ObjectStreamXReference - Class in org.apache.pdfbox.pdfparser.xref
A class representing a reference to an object stream entry in a PDF's crossreference stream (PDFXRefStream).
ObjectStreamXReference(int, COSObjectKey, COSBase, COSObjectKey) - Constructor for class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Prepares a object stream entry reference for the given COSObject in a PDF's crossreference stream (PDFXRefStream).
OBJR - Static variable in class org.apache.pdfbox.cos.COSName
 
OC - Static variable in class org.apache.pdfbox.cos.COSName
 
OCG - Static variable in class org.apache.pdfbox.cos.COSName
 
OCGS - Static variable in class org.apache.pdfbox.cos.COSName
 
OCMD - Static variable in class org.apache.pdfbox.cos.COSName
 
OCPROPERTIES - Static variable in class org.apache.pdfbox.cos.COSName
 
OCSP - Static variable in class org.apache.pdfbox.cos.COSName
 
OCSPS - Static variable in class org.apache.pdfbox.cos.COSName
 
OE - Static variable in class org.apache.pdfbox.cos.COSName
 
ofCOSIntegers(List<Integer>) - Static method in class org.apache.pdfbox.cos.COSArray
This will take a list of integer objects and return a COSArray of COSInteger objects.
ofCOSNames(List<String>) - Static method in class org.apache.pdfbox.cos.COSArray
This will take a list of string objects and return a COSArray of COSName objects.
ofCOSStrings(List<String>) - Static method in class org.apache.pdfbox.cos.COSArray
This will take a list of string objects and return a COSArray of COSName objects.
OFF - Static variable in class org.apache.pdfbox.cos.COSName
"OFF", to be used for OCGs, not for Acroform
Off - Static variable in class org.apache.pdfbox.cos.COSName
"Off", to be used for Acroform, not for OCGs
OID - Static variable in class org.apache.pdfbox.cos.COSName
 
ON - Static variable in class org.apache.pdfbox.cos.COSName
 
ONE - Static variable in class org.apache.pdfbox.cos.COSFloat
 
ONE - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number one.
OP - Static variable in class org.apache.pdfbox.cos.COSName
 
OP_NS - Static variable in class org.apache.pdfbox.cos.COSName
 
OPEN_ACTION - Static variable in class org.apache.pdfbox.cos.COSName
 
OPEN_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
OpenMode - Enum in org.apache.pdfbox.pdmodel.interactive.action
This will specify whether to open the destination document in a new window.
openNode() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
 
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.
OPERATION_OPEN - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
The open operation for the launch.
OPERATION_PRINT - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
The print operation for the launch.
Operator - Class in org.apache.pdfbox.contentstream.operator
An Operator in a PDF content stream.
Operator - Interface in org.apache.pdfbox.pdmodel.common.function.type4
Interface for PostScript operators.
operatorException(Operator, List<COSBase>, IOException) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when an exception is thrown by an operator.
OperatorName - Class in org.apache.pdfbox.contentstream.operator
 
OperatorProcessor - Class in org.apache.pdfbox.contentstream.operator
Processes a PDF operator.
OperatorProcessor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.OperatorProcessor
Creates a new OperatorProcessor.
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
 
OPT - Static variable in class org.apache.pdfbox.cos.COSName
 
ORDER - Static variable in class org.apache.pdfbox.cos.COSName
 
ORDERING - Static variable in class org.apache.pdfbox.cos.COSName
 
org.apache.pdfbox - package org.apache.pdfbox
 
org.apache.pdfbox.contentstream - package org.apache.pdfbox.contentstream
This package contains provides classes for working with content streams.
org.apache.pdfbox.contentstream.operator - package org.apache.pdfbox.contentstream.operator
This package contains implementations of all of the PDF operators.
org.apache.pdfbox.contentstream.operator.color - package org.apache.pdfbox.contentstream.operator.color
 
org.apache.pdfbox.contentstream.operator.graphics - package org.apache.pdfbox.contentstream.operator.graphics
This package contains implementations of all of the PDF graphics operators.
org.apache.pdfbox.contentstream.operator.markedcontent - package org.apache.pdfbox.contentstream.operator.markedcontent
 
org.apache.pdfbox.contentstream.operator.state - package org.apache.pdfbox.contentstream.operator.state
 
org.apache.pdfbox.contentstream.operator.text - package org.apache.pdfbox.contentstream.operator.text
 
org.apache.pdfbox.cos - package org.apache.pdfbox.cos
These are the low level objects that make up a PDF document.
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.multipdf - package org.apache.pdfbox.multipdf
 
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.pdfparser.xref - package org.apache.pdfbox.pdfparser.xref
 
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.pdfwriter.compress - package org.apache.pdfbox.pdfwriter.compress
 
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.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.fixup - package org.apache.pdfbox.pdmodel.fixup
 
org.apache.pdfbox.pdmodel.fixup.processor - package org.apache.pdfbox.pdmodel.fixup.processor
 
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.font.encoding - package org.apache.pdfbox.pdmodel.font.encoding
 
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.blend - package org.apache.pdfbox.pdmodel.graphics.blend
 
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.form - package org.apache.pdfbox.pdmodel.graphics.form
This package deals with Form XObjects that are stored in a PDF document.
org.apache.pdfbox.pdmodel.graphics.image - package org.apache.pdfbox.pdmodel.graphics.image
This package deals with images 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.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.state - package org.apache.pdfbox.pdmodel.graphics.state
This package deals with graphics states within the 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.annotation - package org.apache.pdfbox.pdmodel.interactive.annotation
The annotation package contains classes that work with PDF annotation elements.
org.apache.pdfbox.pdmodel.interactive.annotation.handlers - package org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
org.apache.pdfbox.pdmodel.interactive.annotation.layout - package org.apache.pdfbox.pdmodel.interactive.annotation.layout
 
org.apache.pdfbox.pdmodel.interactive.digitalsignature - package org.apache.pdfbox.pdmodel.interactive.digitalsignature
The digital 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 for handling Interactive Forms, also known as "AcroForms".
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.printing - package org.apache.pdfbox.printing
 
org.apache.pdfbox.rendering - package org.apache.pdfbox.rendering
 
org.apache.pdfbox.text - package org.apache.pdfbox.text
 
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.filetypedetector - package org.apache.pdfbox.util.filetypedetector
 
Orientation - Enum in org.apache.pdfbox.printing
Orientation of printed pages.
OS - Static variable in class org.apache.pdfbox.cos.COSName
 
OUT_OF_RANGE_MAX - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for an out of range value which is bigger than Log.MAX_VALUE.
OUT_OF_RANGE_MIN - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for an out of range value which is smaller than Log.MIN_VALUE.
OUTLINES - Static variable in class org.apache.pdfbox.cos.COSName
 
output - Variable in class org.apache.pdfbox.text.PDFTextStripper
 
OUTPUT_CONDITION - Static variable in class org.apache.pdfbox.cos.COSName
 
OUTPUT_CONDITION_IDENTIFIER - Static variable in class org.apache.pdfbox.cos.COSName
 
OUTPUT_INTENT - Static variable in class org.apache.pdfbox.cos.COSName
 
OUTPUT_INTENTS - Static variable in class org.apache.pdfbox.cos.COSName
 
OVERLAY - Static variable in class org.apache.pdfbox.cos.COSName
 
Overlay - Class in org.apache.pdfbox.multipdf
Adds an overlay to an existing PDF document.
Overlay() - Constructor for class org.apache.pdfbox.multipdf.Overlay
 
overlay(Map<Integer, String>) - Method in class org.apache.pdfbox.multipdf.Overlay
This will add overlays to a document.
OVERLAY - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
Overlay.Position - Enum in org.apache.pdfbox.multipdf
Possible location of the overlaid pages: foreground or background.
overlayDocuments(Map<Integer, PDDocument>) - Method in class org.apache.pdfbox.multipdf.Overlay
This will add overlays documents to a document.
overwrite(int, String) - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
This will add a character encoding.
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
 
P - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
P
PA - Static variable in class org.apache.pdfbox.cos.COSName
 
PAGE - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
PAGE_LAYOUT - Static variable in class org.apache.pdfbox.cos.COSName
 
PAGE_MODE - Static variable in class org.apache.pdfbox.cos.COSName
 
PageDrawer - Class in org.apache.pdfbox.rendering
Paints a page in a PDF document to a Graphics context.
PageDrawer(PageDrawerParameters) - Constructor for class org.apache.pdfbox.rendering.PageDrawer
Constructor.
PageDrawerParameters - Class in org.apache.pdfbox.rendering
Parameters for a PageDrawer.
PageExtractor - Class in org.apache.pdfbox.multipdf
This class will extract one or more sequential pages and create a new document.
PageExtractor(PDDocument) - Constructor for class org.apache.pdfbox.multipdf.PageExtractor
Creates a new instance of PageExtractor
PageExtractor(PDDocument, int, int) - Constructor for class org.apache.pdfbox.multipdf.PageExtractor
Creates a new instance of PageExtractor
PageLayout - Enum in org.apache.pdfbox.pdmodel
A name object specifying the page layout shall be used when the document is opened.
PageMode - Enum in org.apache.pdfbox.pdmodel
A name object specifying how the document shall be displayed when opened.
PAGES - Static variable in class org.apache.pdfbox.cos.COSName
 
pageWidth(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
PAINT_COLORED - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
paint type 1 = colored tiling pattern.
PAINT_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
PAINT_UNCOLORED - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
paint type 2 = uncolored tiling pattern.
PANOSE - Static variable in class org.apache.pdfbox.cos.COSName
 
PARAMS - Static variable in class org.apache.pdfbox.cos.COSName
 
params - Variable in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
The params dictionary.
PARENT - Static variable in class org.apache.pdfbox.cos.COSName
 
parent - Variable in class org.apache.pdfbox.pdmodel.font.PDCIDFont
 
PARENT_TREE - Static variable in class org.apache.pdfbox.cos.COSName
 
PARENT_TREE_NEXT_KEY - Static variable in class org.apache.pdfbox.cos.COSName
 
parse() - Method in class org.apache.pdfbox.pdfparser.FDFParser
This will parse the stream and populate the FDFDocument object.
parse() - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the stream and populate the PDDocument object.
parse(boolean) - Method in class org.apache.pdfbox.pdfparser.PDFParser
This will parse the stream and populate the PDDocument object.
parse() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will parse all the tokens in the stream.
parse(XrefTrailerResolver) - Method in class org.apache.pdfbox.pdfparser.PDFXrefStreamParser
Parses through the unfiltered stream and populates the xrefTable HashMap.
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.
parse(InputStream, boolean) - Static method in class org.apache.pdfbox.util.XMLUtil
This will parse an XML stream and create a DOM document.
parseAllObjects() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
Parse all compressed objects.
parseCOSArray() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF array object.
parseCOSDictionary(boolean) - 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) - Method in class org.apache.pdfbox.pdfparser.COSParser
This will read a COSStream from the input stream using length attribute within dictionary.
parseCOSString() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a PDF string.
parseDirObject() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will parse a directory object from the stream.
parseFDFHeader() - Method in class org.apache.pdfbox.pdfparser.COSParser
Parse the header of a fdf.
parseHex(String) - Static method in class org.apache.pdfbox.cos.COSString
This will create a COS string from a string of hex characters.
parseInt(String) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
Parses a value of type "int".
parseNextToken() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
This will parse the next token in the stream.
parseObject(long) - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
Search for/parse the object with the given object number.
parseObjectDynamically(COSObjectKey, boolean) - Method in class org.apache.pdfbox.pdfparser.COSParser
Parse the object for the given object key.
parseObjectStreamObject(long, COSObjectKey) - Method in class org.apache.pdfbox.pdfparser.COSParser
Parse the object with the given key from the object stream with the given number.
parsePDFHeader() - Method in class org.apache.pdfbox.pdfparser.COSParser
Parse the header of a pdf.
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.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".
parseXrefTable(long) - Method in class org.apache.pdfbox.pdfparser.COSParser
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.cos.COSName
 
PART - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Part
PATH - Static variable in class org.apache.pdfbox.cos.COSName
 
PATTERN - Static variable in class org.apache.pdfbox.cos.COSName
 
PATTERN_SPACE - Static variable in class org.apache.pdfbox.util.StringUtil
 
PATTERN_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
PC - Static variable in class org.apache.pdfbox.cos.COSName
 
PDAbstractAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Generic handler to generate the fields appearance.
PDAbstractAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
 
PDAbstractAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
 
PDAbstractPattern - Class in org.apache.pdfbox.pdmodel.graphics.pattern
This class wraps a pattern dictionary.
PDAbstractPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Creates a new Pattern dictionary.
PDAbstractPattern(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Creates a new Pattern dictionary from the given COS dictionary.
PDAcroForm - Class in org.apache.pdfbox.pdmodel.interactive.form
An interactive form, also known as an AcroForm.
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
This represents an action that can be executed in a PDF document.
PDAction() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAction
Default constructor.
PDAction(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAction
Constructor.
PDActionEmbeddedGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a embedded go-to action that can be executed in a PDF document.
PDActionEmbeddedGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
Default constructor.
PDActionEmbeddedGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
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
This represents a go-to action that can be executed in a PDF document.
PDActionGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo
Default constructor.
PDActionGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo
Constructor.
PDActionHide - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a thread action that can be executed in a PDF document.
PDActionHide() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
Default Constructor
PDActionHide(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
Constructor
PDActionImportData - Class in org.apache.pdfbox.pdmodel.interactive.action
 
PDActionImportData() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData
Default constructor.
PDActionImportData(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData
Constructor.
PDActionJavaScript - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a JavaScript action.
PDActionJavaScript() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript
Constructor #1.
PDActionJavaScript(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript
Constructor.
PDActionJavaScript(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript
Constructor #2.
PDActionLaunch - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a launch action that can be executed in a PDF document.
PDActionLaunch() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
Default constructor.
PDActionLaunch(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
Constructor.
PDActionMovie - Class in org.apache.pdfbox.pdmodel.interactive.action
 
PDActionMovie() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie
Default constructor.
PDActionMovie(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie
Constructor.
PDActionNamed - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a named action in a PDF document.
PDActionNamed() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionNamed
Default constructor.
PDActionNamed(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionNamed
Constructor.
PDActionRemoteGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action
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.PDActionRemoteGoTo
Default constructor.
PDActionRemoteGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
Constructor.
PDActionResetForm - Class in org.apache.pdfbox.pdmodel.interactive.action
 
PDActionResetForm() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm
Default constructor.
PDActionResetForm(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm
Constructor.
PDActionSound - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a Sound action that can be executed in a PDF document.
PDActionSound() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Default constructor.
PDActionSound(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Constructor.
PDActionSubmitForm - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a Submit-Form action that can be executed in a PDF document.
PDActionSubmitForm() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
Default Constructor
PDActionSubmitForm(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
Constructor
PDActionThread - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a thread action that can be executed in a PDF document.
PDActionThread() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
Default constructor.
PDActionThread(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
Constructor.
PDActionURI - Class in org.apache.pdfbox.pdmodel.interactive.action
This represents a URI action that can be executed in a PDF document.
PDActionURI() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDActionURI
Default constructor.
PDActionURI(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.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
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.
PDAnnotationCaret - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationCaret() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
 
PDAnnotationCaret(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
Creates a Caret annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationCircle - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationCircle() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
 
PDAnnotationCircle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
Creates a circle annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationFileAttachment - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents a file attachment.
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.
PDAnnotationFreeText - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationFreeText() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
 
PDAnnotationFreeText(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Creates a FreeText annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationHighlight - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationHighlight() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
Constructor.
PDAnnotationHighlight(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
Constructor.
PDAnnotationInk - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationInk() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
Constructor.
PDAnnotationInk(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
Constructor.
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 additional 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.
PDAnnotationPolygon - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationPolygon() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
Constructor.
PDAnnotationPolygon(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
Constructor.
PDAnnotationPolyline - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationPolyline() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
Constructor.
PDAnnotationPolyline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
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.
PDAnnotationSound - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationSound() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSound
 
PDAnnotationSound(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSound
Creates a sound annotation from a COSDictionary, expected to be a correct object definition.
PDAnnotationSquare - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationSquare() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
 
PDAnnotationSquare(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
Creates a square 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 elliptical 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
Constructor.
PDAnnotationSquiggly - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationSquiggly() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
Constructor.
PDAnnotationSquiggly(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
Constructor.
PDAnnotationStrikeout - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationStrikeout() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
Constructor.
PDAnnotationStrikeout(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
Constructor.
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 the 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.
PDAnnotationUnderline - Class in org.apache.pdfbox.pdmodel.interactive.annotation
 
PDAnnotationUnderline() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline
Constructor.
PDAnnotationUnderline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline
Constructor.
PDAnnotationUnknown - Class in org.apache.pdfbox.pdmodel.interactive.annotation
This is the class that represents an arbitrary Unknown Annotation type.
PDAnnotationUnknown(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown
Creates an arbitrary 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 annotation.
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.
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.
PDAppearanceContentStream - Class in org.apache.pdfbox.pdmodel
Provides the ability to write to an appearance content stream.
PDAppearanceContentStream(PDAppearanceStream) - Constructor for class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Create a new appearance stream.
PDAppearanceContentStream(PDAppearanceStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Create a new appearance stream.
PDAppearanceContentStream(PDAppearanceStream, OutputStream) - Constructor for class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Create a new appearance stream.
PDAppearanceDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
An appearance dictionary specifying how the annotation shall be presented visually on the page.
PDAppearanceDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor for embedding.
PDAppearanceDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
Constructor for reading.
PDAppearanceEntry - Class in org.apache.pdfbox.pdmodel.interactive.annotation
An entry in an appearance dictionary.
PDAppearanceEntry(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry
Constructor for reading.
PDAppearanceHandler - Interface in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDAppearanceStream - Class in org.apache.pdfbox.pdmodel.interactive.annotation
An appearance stream is a form XObject, a self-contained content stream that shall be rendered inside the annotation rectangle.
PDAppearanceStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Creates a Form XObject for reading.
PDAppearanceStream(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
Creates a Form Image XObject for writing, in the given document.
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.
PDButton - Class in org.apache.pdfbox.pdmodel.interactive.form
A button field represents an interactive control on the screen that the user can manipulate with the mouse.
PDCalGray - Class in org.apache.pdfbox.pdmodel.graphics.color
A CalGray colour space is a special case of a single-component CIE-based colour space.
PDCalGray() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Create a new CalGray color space.
PDCalGray(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
Creates a new CalGray color space using the given COS array.
PDCalRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
A CalRGB colour space is a CIE-based colour space with one transformation stage instead of two.
PDCalRGB() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Creates a new CalRGB color space.
PDCalRGB(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Creates a new CalRGB color space using the given COS array.
PDCaretAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the caret annotations appearance.
PDCaretAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCaretAppearanceHandler
 
PDCaretAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCaretAppearanceHandler
 
PDCheckBox - Class in org.apache.pdfbox.pdmodel.interactive.form
A check box toggles between two states, on and off.
PDCheckBox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
 
PDChoice - Class in org.apache.pdfbox.pdmodel.interactive.form
A choice field contains several text items, one or more of which shall be selected as the field value.
PDChoice(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
 
PDCIDFont - Class in org.apache.pdfbox.pdmodel.font
A CIDFont.
PDCIDFontType0 - Class in org.apache.pdfbox.pdmodel.font
Type 0 CIDFont (CFF).
PDCIDFontType0(COSDictionary, PDType0Font) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType0
Constructor.
PDCIDFontType2 - Class in org.apache.pdfbox.pdmodel.font
Type 2 CIDFont (TrueType).
PDCIDFontType2(COSDictionary, PDType0Font) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
Constructor.
PDCIDFontType2(COSDictionary, PDType0Font, TrueTypeFont) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
Constructor.
PDCIDSystemInfo - Class in org.apache.pdfbox.pdmodel.font
Represents a CIDSystemInfo.
PDCIEBasedColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
CIE-based colour spaces specify colours in a way that is independent of the characteristics of any particular output device.
PDCIEBasedColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCIEBasedColorSpace
 
PDCIEDictionaryBasedColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
CIE-based colour spaces that use a dictionary.
PDCIEDictionaryBasedColorSpace(COSName) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
PDCIEDictionaryBasedColorSpace(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
Creates a new CalRGB color space using the given COS array.
PDCircleAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the circle annotations appearance.
PDCircleAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCircleAppearanceHandler
 
PDCircleAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDCircleAppearanceHandler
 
PDColor - Class in org.apache.pdfbox.pdmodel.graphics.color
A color value, consisting of one or more color components, or for pattern color spaces, a name and optional color components.
PDColor(COSArray, PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Creates a PDColor containing the given color value.
PDColor(float[], PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Creates a PDColor containing the given color component values.
PDColor(COSName, PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Creates a PDColor containing the given pattern name.
PDColor(float[], COSName, PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Creates a PDColor containing the given color component values and pattern name.
PDColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
A color space specifies how the colours of graphics objects will be painted on the page.
PDColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
 
PDComboBox - Class in org.apache.pdfbox.pdmodel.interactive.form
A combo box consisting of a drop-down list.
PDComboBox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDComboBox
 
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.
PDContentStream - Interface in org.apache.pdfbox.contentstream
A content stream.
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
Allows colors to be specified according to the subtractive CMYK (cyan, magenta, yellow, black) model typical of printers and other paper-based output devices.
PDDeviceCMYK() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
PDDeviceColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
Device colour spaces directly specify colours or shades of gray produced by an output device.
PDDeviceColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceColorSpace
 
PDDeviceGray - Class in org.apache.pdfbox.pdmodel.graphics.color
A color space with black, white, and intermediate shades of gray.
PDDeviceN - Class in org.apache.pdfbox.pdmodel.graphics.color
DeviceN colour spaces may contain an arbitrary number of colour components.
PDDeviceN() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Creates a new DeviceN color space.
PDDeviceN(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Creates a new DeviceN color space from the given COS array.
PDDeviceNAttributes - Class in org.apache.pdfbox.pdmodel.graphics.color
Contains additional information about the components of colour space.
PDDeviceNAttributes() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Creates a new DeviceN colour space attributes dictionary.
PDDeviceNAttributes(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Creates a new DeviceN colour space attributes dictionary from the given dictionary.
PDDeviceNProcess - Class in org.apache.pdfbox.pdmodel.graphics.color
A DeviceN Process Dictionary
PDDeviceNProcess() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
Creates a new DeviceN Process Dictionary.
PDDeviceNProcess(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
Creates a new DeviceN Process Dictionary from the given attributes.
PDDeviceRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
Colours in the DeviceRGB colour space are specified according to the additive RGB (red-green-blue) colour model.
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
Creates an empty PDF document.
PDDocument(RandomAccessStreamCache.StreamCacheCreateFunction) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Creates an empty PDF document.
PDDocument(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocument(COSDocument, RandomAccessRead) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocument(COSDocument, RandomAccessRead, AccessPermission) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
Constructor that uses an existing document.
PDDocumentCatalog - Class in org.apache.pdfbox.pdmodel
The Document Catalog of a PDF.
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.
PDDocumentFixup - Interface in org.apache.pdfbox.pdmodel.fixup
 
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 /Dests 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.
PDDocumentProcessor - Interface in org.apache.pdfbox.pdmodel.fixup.processor
 
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
PDEmbeddedFile(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
PDEmbeddedFile(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
PDEmbeddedFile(PDDocument, InputStream, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
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.
PDEncryption - Class in org.apache.pdfbox.pdmodel.encryption
This class is a specialized view of the encryption dictionary of a PDF document.
PDEncryption() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryption
creates a new empty encryption dictionary.
PDEncryption(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryption
creates a new encryption dictionary from the low level dictionary provided.
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.state
An extended graphics state dictionary.
PDExtendedGraphicsState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
Default constructor, creates blank graphics state.
PDExtendedGraphicsState(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.state.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
 
PDFCloneUtility - Class in org.apache.pdfbox.multipdf
Utility class used to clone PDF objects.
PDFCloneUtility(PDDocument) - Constructor for class org.apache.pdfbox.multipdf.PDFCloneUtility
Creates a new instance for the given target document.
PDFGraphicsStreamEngine - Class in org.apache.pdfbox.contentstream
PDFStreamEngine subclass for advanced processing of graphics.
PDFGraphicsStreamEngine(PDPage) - Constructor for class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Constructor.
PDField - Class in org.apache.pdfbox.pdmodel.interactive.form
A field in an interactive form.
PDFieldFactory - Class in org.apache.pdfbox.pdmodel.interactive.form
A PDField factory.
PDFieldTree - Class in org.apache.pdfbox.pdmodel.interactive.form
The field tree.
PDFieldTree(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDFieldTree
Constructor for reading.
PDFileAttachmentAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDFileAttachmentAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFileAttachmentAppearanceHandler
 
PDFileAttachmentAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFileAttachmentAppearanceHandler
 
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
 
PDFMarkedContentExtractor - Class in org.apache.pdfbox.text
This is an stream engine to extract the marked content of a pdf.
PDFMarkedContentExtractor() - Constructor for class org.apache.pdfbox.text.PDFMarkedContentExtractor
Instantiate a new PDFTextStripper object.
PDFMarkedContentExtractor(String) - Constructor for class org.apache.pdfbox.text.PDFMarkedContentExtractor
Constructor.
PDFMergerUtility - Class in org.apache.pdfbox.multipdf
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.multipdf.PDFMergerUtility
Instantiate a new PDFMergerUtility.
PDFMergerUtility.AcroFormMergeMode - Enum in org.apache.pdfbox.multipdf
The mode to use when merging AcroForm between documents: PDFMergerUtility.AcroFormMergeMode.JOIN_FORM_FIELDS_MODE fields with the same fully qualified name will be merged into one with the widget annotations of the merged fields becoming part of the same field.
PDFMergerUtility.DocumentMergeMode - Enum in org.apache.pdfbox.multipdf
The mode to use when merging documents: PDFMergerUtility.DocumentMergeMode.OPTIMIZE_RESOURCES_MODE Optimizes resource handling such as closing documents early.
PDFObjectStreamParser - Class in org.apache.pdfbox.pdfparser
This will parse a PDF 1.5 object stream and extract the object with given object number from the stream.
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(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFont
Constructor.
PDFontDescriptor - Class in org.apache.pdfbox.pdmodel.font
A font descriptor.
PDFontDescriptor(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Creates a PDFontDescriptor from a COS dictionary.
PDFontFactory - Class in org.apache.pdfbox.pdmodel.font
Creates the appropriate font subtype based on information in the dictionary.
PDFontLike - Interface in org.apache.pdfbox.pdmodel.font
A font-like object.
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.
PDFormContentStream - Class in org.apache.pdfbox.pdmodel
 
PDFormContentStream(PDFormXObject) - Constructor for class org.apache.pdfbox.pdmodel.PDFormContentStream
Create a new form XObject 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.
PDFormXObject - Class in org.apache.pdfbox.pdmodel.graphics.form
A Form XObject.
PDFormXObject(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Creates a Form XObject for reading.
PDFormXObject(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Creates a Form XObject for reading.
PDFormXObject(COSStream, ResourceCache) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Creates a Form XObject for reading.
PDFormXObject(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Creates a Form Image XObject for writing, in the given document.
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
 
PDFPageable - Class in org.apache.pdfbox.printing
Prints a PDF document using its original paper size.
PDFPageable(PDDocument) - Constructor for class org.apache.pdfbox.printing.PDFPageable
Creates a new PDFPageable.
PDFPageable(PDDocument, Orientation) - Constructor for class org.apache.pdfbox.printing.PDFPageable
Creates a new PDFPageable with the given page orientation.
PDFPageable(PDDocument, Orientation, boolean) - Constructor for class org.apache.pdfbox.printing.PDFPageable
Creates a new PDFPageable with the given page orientation and with optional page borders shown.
PDFPageable(PDDocument, Orientation, boolean, float) - Constructor for class org.apache.pdfbox.printing.PDFPageable
Creates a new PDFPageable with the given page orientation and with optional page borders shown.
PDFParser - Class in org.apache.pdfbox.pdfparser
 
PDFParser(RandomAccessRead) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor.
PDFParser(RandomAccessRead, String) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor.
PDFParser(RandomAccessRead, String, InputStream, String) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor.
PDFParser(RandomAccessRead, String, InputStream, String, RandomAccessStreamCache.StreamCacheCreateFunction) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
Constructor.
PDFPrintable - Class in org.apache.pdfbox.printing
Prints pages from a PDF document using any page size or scaling mode.
PDFPrintable(PDDocument) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable.
PDFPrintable(PDDocument, Scaling) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable with the given page scaling.
PDFPrintable(PDDocument, Scaling, boolean) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
PDFPrintable(PDDocument, Scaling, boolean, float) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
PDFPrintable(PDDocument, Scaling, boolean, float, boolean) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
PDFPrintable(PDDocument, Scaling, boolean, float, boolean, PDFRenderer) - Constructor for class org.apache.pdfbox.printing.PDFPrintable
Creates a new PDFPrintable with the given page scaling and with optional page borders shown.
PDFreeTextAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDFreeTextAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFreeTextAppearanceHandler
 
PDFreeTextAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDFreeTextAppearanceHandler
 
PDFRenderer - Class in org.apache.pdfbox.rendering
Renders a PDF document to an AWT BufferedImage.
PDFRenderer(PDDocument) - Constructor for class org.apache.pdfbox.rendering.PDFRenderer
Creates a new PDFRenderer.
PDFStreamEngine - Class in org.apache.pdfbox.contentstream
Processes a PDF content stream and executes certain operations.
PDFStreamEngine() - Constructor for class org.apache.pdfbox.contentstream.PDFStreamEngine
Creates a new PDFStreamEngine.
PDFStreamParser - Class in org.apache.pdfbox.pdfparser
This will parse a PDF byte stream and extract operands and such.
PDFStreamParser(PDContentStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
Constructor.
PDFStreamParser(byte[]) - 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
Class to build PDF template.
PDFTemplateCreator(PDFTemplateBuilder) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateCreator
Constructor.
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
 
PDFTextStripper - Class in org.apache.pdfbox.text
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.text.PDFTextStripper
Instantiate a new PDFTextStripper object.
PDFTextStripperByArea - Class in org.apache.pdfbox.text
This will extract text from a specified region in the PDF.
PDFTextStripperByArea() - Constructor for class org.apache.pdfbox.text.PDFTextStripperByArea
Constructor.
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 (exponential interpolation) 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 (stitching) 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 (PostScript calculator) function in a PDF document.
PDFunctionType4(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
Constructor.
PDFunctionTypeIdentity - Class in org.apache.pdfbox.pdmodel.common.function
The identity function.
PDFunctionTypeIdentity(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity
 
PDFXRefStream - Class in org.apache.pdfbox.pdfparser
 
PDFXRefStream(COSDocument) - 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) - 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
Creates a new gamma.
PDGamma(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Creates a new gamma from a COS array.
PDGraphicsState - Class in org.apache.pdfbox.pdmodel.graphics.state
The current state of the graphics parameters when executing a content stream.
PDGraphicsState(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Constructor with a given page size to initialize the clipping path.
PDHighlightAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDHighlightAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDHighlightAppearanceHandler
 
PDHighlightAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDHighlightAppearanceHandler
 
PDICCBased - Class in org.apache.pdfbox.pdmodel.graphics.color
ICCBased color spaces are based on a cross-platform color profile as defined by the International Color Consortium (ICC).
PDICCBased(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Creates a new ICC color space with an empty stream.
PDImage - Interface in org.apache.pdfbox.pdmodel.graphics.image
An image in a PDF document.
PDImageXObject - Class in org.apache.pdfbox.pdmodel.graphics.image
An Image XObject.
PDImageXObject(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Creates an Image XObject in the given document.
PDImageXObject(PDDocument, InputStream, COSBase, int, int, int, PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Creates an Image XObject in the given document using the given filtered stream.
PDImageXObject(PDStream, PDResources) - Constructor for class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Creates an Image XObject with the given stream as its contents and current color spaces.
PDImmutableRectangle - Class in org.apache.pdfbox.pdmodel.common
Immutable class for constant sizes.
PDImmutableRectangle(float, float) - Constructor for class org.apache.pdfbox.pdmodel.common.PDImmutableRectangle
Constructor for immutable rectangle.
PDIndexed - Class in org.apache.pdfbox.pdmodel.graphics.color
An Indexed colour space specifies that an area is to be painted using a colour table of arbitrary colours from another color space.
PDIndexed() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Creates a new Indexed color space.
PDIndexed(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Creates a new indexed color space from the given PDF array.
PDIndexed(COSArray, PDResources) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
Creates a new indexed color space from the given PDF array.
PDInkAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the ink annotations appearance.
PDInkAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDInkAppearanceHandler
 
PDInkAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDInkAppearanceHandler
 
PDInlineImage - Class in org.apache.pdfbox.pdmodel.graphics.image
An inline image object which uses a special syntax to express the data for a small image directly within the content stream.
PDInlineImage(COSDictionary, byte[], PDResources) - Constructor for class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
Creates an inline image from the given parameters and data.
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.
PDJPXColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
A color space embedded in a JPX file.
PDJPXColorSpace(ColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
Creates a new JPX color space from the given AWT color space.
PDLab - Class in org.apache.pdfbox.pdmodel.graphics.color
A Lab colour space is a CIE-based ABC colour space with two transformation stages.
PDLab() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Creates a new Lab color space.
PDLab(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
Creates a new Lab color space from a PDF 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.
PDLineAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDLineAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLineAppearanceHandler
 
PDLineAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLineAppearanceHandler
 
PDLineDashPattern - Class in org.apache.pdfbox.pdmodel.graphics
A line dash pattern for stroking paths.
PDLineDashPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Creates a new line dash pattern, with no dashes and a phase of 0.
PDLineDashPattern(COSArray, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
Creates a new line dash pattern from a dash array and phase.
PDLinkAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the link annotations appearance.
PDLinkAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLinkAppearanceHandler
 
PDLinkAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDLinkAppearanceHandler
 
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.
PDListBox - Class in org.apache.pdfbox.pdmodel.interactive.form
A scrollable list box.
PDListBox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDListBox
 
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.
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.
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) - 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
Type 1 Multiple Master Font.
PDMMType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDMMType1Font
Creates an MMType1Font from a Font dictionary in a PDF.
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.
PDNameTreeNode<T extends COSObjectable> - Class in org.apache.pdfbox.pdmodel.common
This class represents a node in a name tree.
PDNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Constructor.
PDNonTerminalField - Class in org.apache.pdfbox.pdmodel.interactive.form
A non terminal field in an interactive form.
PDNonTerminalField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
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
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.
PDOptionalContentGroup.RenderState - Enum in org.apache.pdfbox.pdmodel.graphics.optionalcontent
Enumeration for the renderState dictionary entry on the "Export", "View" and "Print" dictionary.
PDOptionalContentMembershipDictionary - Class in org.apache.pdfbox.pdmodel.graphics.optionalcontent
An optional content membership dictionary (OCMD).
PDOptionalContentMembershipDictionary() - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
Creates a new optional content membership dictionary (OCMD).
PDOptionalContentMembershipDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
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 item 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
Base class for a node in the outline of 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
 
PDOutputIntent - Class in org.apache.pdfbox.pdmodel.graphics.color
An Output Intent describes the colour reproduction characteristics of a possible output device or production condition.
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
A page in a PDF document.
PDPage() - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new PDPage instance for embedding, with a size of U.S.
PDPage(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage for embedding.
PDPage(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
Creates a new instance of PDPage for reading.
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
Provides the ability to write to a page content stream.
PDPageContentStream(PDDocument, PDPage) - Constructor for class org.apache.pdfbox.pdmodel.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean) - Constructor for class org.apache.pdfbox.pdmodel.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean) - Constructor for class org.apache.pdfbox.pdmodel.PDPageContentStream
Create a new PDPage content stream.
PDPageContentStream(PDDocument, PDAppearanceStream) - Constructor for class org.apache.pdfbox.pdmodel.PDPageContentStream
Create a new appearance stream.
PDPageContentStream(PDDocument, PDAppearanceStream, OutputStream) - Constructor for class org.apache.pdfbox.pdmodel.PDPageContentStream
Create a new appearance stream.
PDPageContentStream.AppendMode - Enum in org.apache.pdfbox.pdmodel
This is to choose what to do with the stream: overwrite, append or prepend.
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.
PDPageTree - Class in org.apache.pdfbox.pdmodel
The page tree, which defines the ordering of pages in the document in an efficient manner.
PDPageTree() - Constructor for class org.apache.pdfbox.pdmodel.PDPageTree
Constructor for embedding.
PDPageTree(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPageTree
Constructor for reading.
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.
PDPanose - Class in org.apache.pdfbox.pdmodel.font
Represents the "Panose" entry of a FontDescriptor's Style dictionary.
PDPanose(byte[]) - Constructor for class org.apache.pdfbox.pdmodel.font.PDPanose
 
PDPanoseClassification - Class in org.apache.pdfbox.pdmodel.font
Represents a 10-byte PANOSE classification.
PDPanoseClassification(byte[]) - Constructor for class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
PDParentTreeValue - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
Described in the PDF specification in the ParentTree segment of the table "Entries in the structure tree root".
PDParentTreeValue(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDParentTreeValue
 
PDParentTreeValue(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDParentTreeValue
 
PDPattern - Class in org.apache.pdfbox.pdmodel.graphics.color
A Pattern color space is either a Tiling pattern or a Shading pattern.
PDPattern(PDResources) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Creates a new pattern color space.
PDPattern(PDResources, PDColorSpace) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
Creates a new uncolored tiling pattern color space.
PDPatternContentStream - Class in org.apache.pdfbox.pdmodel
 
PDPatternContentStream(PDTilingPattern) - Constructor for class org.apache.pdfbox.pdmodel.PDPatternContentStream
Create a new tiling pattern content stream.
PDPolygonAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the polygon annotations appearance.
PDPolygonAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolygonAppearanceHandler
 
PDPolygonAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolygonAppearanceHandler
 
PDPolylineAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the polyline annotations appearance.
PDPolylineAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolylineAppearanceHandler
 
PDPolylineAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDPolylineAppearanceHandler
 
PDPostScriptXObject - Class in org.apache.pdfbox.pdmodel.graphics
A PostScript XObject.
PDPostScriptXObject(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDPostScriptXObject
Creates a PostScript XObject.
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
A signature build dictionary as specified in the PDF Signature Build Dictionary Specification.
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
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.documentinterchange.markedcontent
A property list is a dictionary containing private information meaningful to the conforming writer creating the marked content.
PDPropertyList() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
Constructor for subclasses.
PDPropertyList(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDPropertyList
Constructor for subclasses.
PDPushButton - Class in org.apache.pdfbox.pdmodel.interactive.form
A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.
PDPushButton(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
PDRadioButton - Class in org.apache.pdfbox.pdmodel.interactive.form
Radio button fields contain a set of related buttons that can each be on or off.
PDRadioButton(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton
 
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
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(float, float, 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
A set of resources available at the page/pages/stream level.
PDResources() - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Constructor for embedding.
PDResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Constructor for reading.
PDResources(COSDictionary, ResourceCache) - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Constructor for reading.
PDResources(COSDictionary, ResourceCache, Map<COSName, SoftReference<PDFont>>) - Constructor for class org.apache.pdfbox.pdmodel.PDResources
Constructor for reading.
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.
PDSeedValueCertificate - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
This class represents a certificate seed value dictionary that is in the seed value which puts constraints on certificates when signing documents.
PDSeedValueCertificate() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Default constructor.
PDSeedValueCertificate(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
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
A Separation color space used to specify either additional colorants or for isolating the control of individual colour components of a device colour space for a subtractive device.
PDSeparation() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Creates a new Separation color space.
PDSeparation(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Creates a new Separation color space from a PDF color space array.
PDShading - Class in org.apache.pdfbox.pdmodel.graphics.shading
A Shading Resource.
PDShading() - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Default constructor.
PDShading(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Constructor using the given shading dictionary.
PDShadingPattern - Class in org.apache.pdfbox.pdmodel.graphics.pattern
A shading pattern dictionary.
PDShadingPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPattern
Creates a new shading pattern.
PDShadingPattern(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPattern
Creates a new shading pattern from the given COS dictionary.
PDShadingType1 - Class in org.apache.pdfbox.pdmodel.graphics.shading
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
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
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
Resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Mesh).
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
Resources for a shading type 5 (Lattice-Form Gouraud-Shade Triangle Mesh).
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
Resources for a shading type 7 (Tensor-Product Patch Mesh).
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.
PDSignatureField - Class in org.apache.pdfbox.pdmodel.interactive.form
A signature field is a form field that contains a digital signature.
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
A simple font.
PDSoftMask - Class in org.apache.pdfbox.pdmodel.graphics.state
Soft mask.
PDSoftMask(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.state.PDSoftMask
Creates a new soft mask.
PDSoundAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDSoundAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSoundAppearanceHandler
 
PDSoundAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSoundAppearanceHandler
 
PDSpecialColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
Special colour spaces add features or properties to an underlying colour space.
PDSpecialColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSpecialColorSpace
 
PDSquareAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
Handler to generate the square annotations appearance.
PDSquareAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquareAppearanceHandler
 
PDSquareAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquareAppearanceHandler
 
PDSquigglyAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDSquigglyAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquigglyAppearanceHandler
 
PDSquigglyAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDSquigglyAppearanceHandler
 
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.
PDStream - Class in org.apache.pdfbox.pdmodel.common
A PDStream represents a stream in a PDF document.
PDStream(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Creates a new empty PDStream object.
PDStream(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Creates a new empty PDStream object.
PDStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Creates a PDStream which wraps the given COSStream.
PDStream(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream, COSName) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStream(PDDocument, InputStream, COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
Constructor.
PDStrikeoutAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDStrikeoutAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDStrikeoutAppearanceHandler
 
PDStrikeoutAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDStrikeoutAppearanceHandler
 
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.
PDStructureElementNameTreeNode - Class in org.apache.pdfbox.pdmodel
todo: JavaDoc
PDStructureElementNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDStructureElementNameTreeNode
Constructor.
PDStructureElementNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDStructureElementNameTreeNode
Constructor.
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.
PDTargetDirectory - Class in org.apache.pdfbox.pdmodel.interactive.action
A target dictionary specifying path information to the target document.
PDTargetDirectory() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Default constructor, creates target directory.
PDTargetDirectory(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Create a target directory from an existing dictionary.
PDTerminalField - Class in org.apache.pdfbox.pdmodel.interactive.form
A field in an interactive form.
PDTerminalField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
Constructor.
PDTextAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDTextAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler
 
PDTextAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler
 
PDTextField - Class in org.apache.pdfbox.pdmodel.interactive.form
A text field is a box or space for text fill-in data typically entered from a keyboard.
PDTextField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
 
PDTextState - Class in org.apache.pdfbox.pdmodel.graphics.state
This class will hold the current state of the text parameters when executing a content stream.
PDTextState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
 
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.
PDTilingPattern - Class in org.apache.pdfbox.pdmodel.graphics.pattern
A tiling pattern dictionary.
PDTilingPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
Creates a new tiling pattern.
PDTilingPattern(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
Creates a new tiling pattern from the given COS dictionary.
PDTilingPattern(COSDictionary, ResourceCache) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
Creates a new tiling pattern from the given COS dictionary.
PDTransition - Class in org.apache.pdfbox.pdmodel.interactive.pagenavigation
Represents a page transition as defined in paragraph 12.4.4.1 of PDF 32000-1:2008
PDTransition() - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
creates a new transition with default "replace" style PDTransitionStyle.R
PDTransition(PDTransitionStyle) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
creates a new transition with the given style.
PDTransition(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
creates a new transition for an existing dictionary
PDTransitionDimension - Enum in org.apache.pdfbox.pdmodel.interactive.pagenavigation
The dimension in which the specified transition effect shall occur.
PDTransitionDirection - Enum in org.apache.pdfbox.pdmodel.interactive.pagenavigation
The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction.
PDTransitionMotion - Enum in org.apache.pdfbox.pdmodel.interactive.pagenavigation
The direction of motion for the specified transition effect.
PDTransitionStyle - Enum in org.apache.pdfbox.pdmodel.interactive.pagenavigation
The transition style that shall be used when moving to the page from another during a presentation.
PDTransparencyGroup - Class in org.apache.pdfbox.pdmodel.graphics.form
A transparency group.
PDTransparencyGroup(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroup
Creates a Transparency Group for reading.
PDTransparencyGroup(COSStream, ResourceCache) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroup
Creates a Transparency Group for reading.
PDTransparencyGroup(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroup
Creates a Transparency Group for writing, in the given document.
PDTransparencyGroupAttributes - Class in org.apache.pdfbox.pdmodel.graphics.form
Transparency group attributes.
PDTransparencyGroupAttributes() - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Creates a group object with /Transparency subtype entry.
PDTransparencyGroupAttributes(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.form.PDTransparencyGroupAttributes
Creates a group object from a given dictionary
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
TrueType font.
PDTrueTypeFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
Creates a new TrueType font from a Font dictionary.
PDType0Font - Class in org.apache.pdfbox.pdmodel.font
A Composite (Type 0) font.
PDType0Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType0Font
Constructor for reading a Type0 font from a PDF file.
PDType1CFont - Class in org.apache.pdfbox.pdmodel.font
Type 1-equivalent CFF font.
PDType1CFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1CFont
Constructor.
PDType1Font - Class in org.apache.pdfbox.pdmodel.font
A PostScript Type 1 Font.
PDType1Font(Standard14Fonts.FontName) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Creates a Type 1 standard 14 font for embedding.
PDType1Font(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Creates a new Type 1 font for embedding.
PDType1Font(PDDocument, InputStream, Encoding) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Creates a new Type 1 font for embedding.
PDType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
Creates a Type 1 font from a Font dictionary in a PDF.
PDType3CharProc - Class in org.apache.pdfbox.pdmodel.font
A Type 3 character procedure.
PDType3CharProc(PDType3Font, COSStream) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3CharProc
 
PDType3Font - Class in org.apache.pdfbox.pdmodel.font
A PostScript Type 3 Font.
PDType3Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3Font
Constructor.
PDType3Font(COSDictionary, ResourceCache) - 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.
PDUnderlineAppearanceHandler - Class in org.apache.pdfbox.pdmodel.interactive.annotation.handlers
 
PDUnderlineAppearanceHandler(PDAnnotation) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDUnderlineAppearanceHandler
 
PDUnderlineAppearanceHandler(PDAnnotation, PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDUnderlineAppearanceHandler
 
PDURIDictionary - Class in org.apache.pdfbox.pdmodel.interactive.action
This is the implementation of an URI dictionary.
PDURIDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDURIDictionary
Constructor.
PDURIDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.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
Constructor
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
Base class for fields which use "Variable Text".
PDVectorFont - Interface in org.apache.pdfbox.pdmodel.font
A vector outline font, e.g.
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
Implementation of PDFTemplateBuilder.
PDVisibleSigBuilder() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
Constructor, creates PDF template structure.
PDVisibleSignDesigner - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Class for visible signature design properties.
PDVisibleSignDesigner(String, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(RandomAccessRead, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(PDDocument, InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(String, BufferedImage, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(RandomAccessRead, BufferedImage, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(PDDocument, BufferedImage, int) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor.
PDVisibleSignDesigner(InputStream) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
Constructor usable for signing existing signature fields.
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
Launch parameters for the windows OS.
PDWindowsLaunchParams() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
Default constructor.
PDWindowsLaunchParams(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
Constructor.
PDXFAResource - Class in org.apache.pdfbox.pdmodel.interactive.form
An XML Forms Architecture (XFA) resource.
PDXFAResource(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDXFAResource
Constructor.
PDXObject - Class in org.apache.pdfbox.pdmodel.graphics
An external object, or "XObject".
PDXObject(COSStream, COSName) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDXObject
Creates a new XObject from the given stream and subtype.
PDXObject(PDStream, COSName) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDXObject
Creates a new XObject from the given stream and subtype.
PDXObject(PDDocument, COSName) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDXObject
Creates a new XObject of the given subtype for writing.
PERCEPTUAL - Static variable in class org.apache.pdfbox.cos.COSName
 
PERMS - Static variable in class org.apache.pdfbox.cos.COSName
 
PG - Static variable in class org.apache.pdfbox.cos.COSName
 
PI - Static variable in class org.apache.pdfbox.cos.COSName
 
PIECE_INFO - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
PlainText - Class in org.apache.pdfbox.pdmodel.interactive.annotation.layout
A block of text.
PlainText(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText
Construct the text block from a single value.
PlainText(List<String>) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainText
Construct the text block from a list of values.
PlainTextFormatter - Class in org.apache.pdfbox.pdmodel.interactive.annotation.layout
TextFormatter to handle plain text formatting for annotation rectangles.
PlainTextFormatter.Builder - Class in org.apache.pdfbox.pdmodel.interactive.annotation.layout
 
PO - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
POPUP - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
PREDICTOR - Static variable in class org.apache.pdfbox.cos.COSName
 
Predictor - Class in org.apache.pdfbox.filter
Helper class to contain predictor decoding used by Flate and LZW filter.
preferredSize(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
Sets the preferred signature size in bytes.
prepareDecryption() - Method in class org.apache.pdfbox.pdfparser.COSParser
Prepare for decryption.
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(PDEncryption, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
Prepares everything to decrypt the document.
prepareForDecryption(PDEncryption, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Prepares everything to decrypt the document.
prepareForDecryption(PDEncryption, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
Prepares everything to decrypt the document.
prepareStreamObject(COSObjectKey, COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterObjectStream
Prepares the given COSObject to be written to this object stream, using the given COSObjectKey as it's ID for indirect references.
PREV - Static variable in class org.apache.pdfbox.cos.COSName
 
PRINT - Static variable in class org.apache.pdfbox.cos.COSName
 
print(Graphics, PageFormat, int) - Method in class org.apache.pdfbox.printing.PDFPrintable
 
PRINT_AREA - Static variable in class org.apache.pdfbox.cos.COSName
 
PRINT_CLIP - Static variable in class org.apache.pdfbox.cos.COSName
 
PRINT_SCALING - Static variable in class org.apache.pdfbox.cos.COSName
 
PRINT_STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
PRIVATE - Static variable in class org.apache.pdfbox.cos.COSName
 
PRIVATE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Private
PROC_SET - Static variable in class org.apache.pdfbox.cos.COSName
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColorSpace
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceCMYKColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceGrayColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceRGBColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColorSpace
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceCMYKColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceGrayColor
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceRGBColor
RG Set the stroking colour space to DeviceRGB and set the colour to use for stroking operations.
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.DrawObject
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.AppendRectangleToPath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.BeginInlineImage
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClipEvenOddRule
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClipNonZeroRule
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseAndStrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseFillEvenOddAndStrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CloseFillNonZeroAndStrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.ClosePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveTo
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateFinalPoint
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.CurveToReplicateInitialPoint
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.DrawObject
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.EndPath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddAndStrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillEvenOddRule
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroAndStrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.FillNonZeroRule
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.LineTo
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.MoveTo
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.ShadingFill
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.graphics.StrokePath
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequence
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.BeginMarkedContentSequenceWithProperties
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.DrawObject
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.markedcontent.EndMarkedContentSequence
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.OperatorProcessor
Process the operator.
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.Concatenate
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.Restore
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.Save
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetFlatness
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetGraphicsStateParameters
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineCapStyle
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineDashPattern
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineJoinStyle
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineMiterLimit
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetLineWidth
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetMatrix
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.state.SetRenderingIntent
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.BeginText
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.EndText
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.MoveText
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.MoveTextSetLeading
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.NextLine
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetCharSpacing
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetFontAndSize
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextHorizontalScaling
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextLeading
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextRenderingMode
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetTextRise
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.SetWordSpacing
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.ShowText
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextAdjusted
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextLine
 
process(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.operator.text.ShowTextLineAndSpace
 
PROCESS - Static variable in class org.apache.pdfbox.cos.COSName
 
process() - Method in class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormDefaultsProcessor
 
process() - Method in class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormGenerateAppearancesProcessor
 
process() - Method in class org.apache.pdfbox.pdmodel.fixup.processor.AcroFormOrphanWidgetsProcessor
 
process() - Method in interface org.apache.pdfbox.pdmodel.fixup.processor.PDDocumentProcessor
 
processAnnotation(PDAnnotation, PDAppearanceStream) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Process the given annotation with the specified appearance stream.
processChildStream(PDContentStream, PDPage) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Process a child stream of the given page.
processOperator(String, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
This is used to handle an operation.
processOperator(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
This is used to handle an operation.
processPage(PDPage) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
This will initialize and process the contents of the stream.
processPage(PDPage) - Method in class org.apache.pdfbox.multipdf.Splitter
Interface to start processing a new page.
processPage(PDPage) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will process the contents of a page.
processPages(PDPageTree) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will process all of the pages and the text that is in them.
processSoftMask(PDTransparencyGroup) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Processes a soft mask transparency group stream.
processTextPosition(TextPosition) - Method in class org.apache.pdfbox.text.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.text.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.text.PDFTextStripperByArea
This will process a TextPosition object and add the text to the list of characters on a page.
processTilingPattern(PDTilingPattern, PDColor, PDColorSpace) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Process the given tiling pattern.
processTilingPattern(PDTilingPattern, PDColor, PDColorSpace, Matrix) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Process the given tiling pattern.
processTransparencyGroup(PDTransparencyGroup) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Processes a transparency group stream.
processType3Stream(PDType3CharProc, Matrix) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Processes a Type 3 character stream.
PRODUCER - Static variable in class org.apache.pdfbox.cos.COSName
 
PROP_BUILD - Static variable in class org.apache.pdfbox.cos.COSName
 
PROPERTIES - Static variable in class org.apache.pdfbox.cos.COSName
 
protect(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Protects the document with a protection policy.
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
 
PS - Static variable in class org.apache.pdfbox.cos.COSName
 
PUB_SEC - Static variable in class org.apache.pdfbox.cos.COSName
 
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
The protection policy to use to protect a document with the public key security handler.
PublicKeyProtectionPolicy() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
Creates a new PublicKeyProtectionPolicy with an empty recipients list.
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.
put(COSObjectKey, COSBase) - Method in class org.apache.pdfbox.pdfwriter.compress.COSObjectPool
Update the key and object maps.
put(K, V) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
put(COSObject, PDFont) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDExtendedGraphicsState) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDShading) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDAbstractPattern) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSObject, PDXObject) - Method in class org.apache.pdfbox.pdmodel.DefaultResourceCache
 
put(COSName, PDFont) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the font resource with the given name.
put(COSName, PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the color space resource with the given name.
put(COSName, PDExtendedGraphicsState) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the extended graphics state resource with the given name.
put(COSName, PDShading) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the shading resource with the given name.
put(COSName, PDAbstractPattern) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the pattern resource with the given name.
put(COSName, PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the property list resource with the given name.
put(COSName, PDXObject) - Method in class org.apache.pdfbox.pdmodel.PDResources
Sets the XObject resource with the given name.
put(COSObject, PDFont) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect font resource in the cache.
put(COSObject, PDColorSpace) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect color space resource in the cache.
put(COSObject, PDExtendedGraphicsState) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect extended graphics state resource in the cache.
put(COSObject, PDShading) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect shading resource in the cache.
put(COSObject, PDAbstractPattern) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect pattern resource in the cache.
put(COSObject, PDPropertyList) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect property list resource in the cache.
put(COSObject, PDXObject) - Method in interface org.apache.pdfbox.pdmodel.ResourceCache
Puts the given indirect XObject resource in the cache.
put(K, V) - Method in class org.apache.pdfbox.util.SmallMap
 
putAll(Map<? extends K, ? extends V>) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
putAll(Map<? extends K, ? extends V>) - Method in class org.apache.pdfbox.util.SmallMap
 
PV - Static variable in class org.apache.pdfbox.cos.COSName
 

Q

Q - Static variable in class org.apache.pdfbox.cos.COSName
 
QUADDING_CENTERED - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
QUADDING_LEFT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
QUADDING_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
 
QUADPOINTS - Static variable in class org.apache.pdfbox.cos.COSName
 
QUOTE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Quote

R

R - Static variable in class org.apache.pdfbox.cos.COSName
 
R - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
RadialShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
AWT PaintContext for radial shading.
RadialShadingContext(PDShadingType3, ColorModel, AffineTransform, Matrix, 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.
RANGE - Static variable in class org.apache.pdfbox.cos.COSName
 
RB - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
RB
RC - Static variable in class org.apache.pdfbox.cos.COSName
 
RD - Static variable in class org.apache.pdfbox.cos.COSName
 
read() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.COSFilterInputStream
 
read(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.COSFilterInputStream
 
read(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.COSFilterInputStream
 
readCMap(COSBase) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Reads a CMap given a COS Stream or Name.
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Reads a character code from a content stream string.
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
readCode(InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
readEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Reads the Encoding from the Font dictionary or the embedded or substituted font file.
readEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
readEncodingFromFont() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
Called by readEncoding() if the encoding needs to be extracted from the font file.
readEncodingFromFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
readEncodingFromFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
 
readEncodingFromFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
 
readEncodingFromFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
 
readExpectedChar(char) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Read one char and throw an exception if it is not the expected value.
readExpectedString(char[], boolean) - Method in class org.apache.pdfbox.pdfparser.BaseParser
Reads given pattern from BaseParser.source.
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.
readInt() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read an integer from the stream.
readLine() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read bytes until the first end of line marker occurs.
readLong() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read an long from the stream.
readObjectNumber() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will read a long from the Stream and throw an IOException if the long value is negative or has more than 10 digits (i.e.
readObjectNumbers() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
Read all object numbers from the compressed object stream.
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.
readStringNumber() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This method is used to read a token by the BaseParser.readInt() and the BaseParser.readLong() method.
REASON - Static variable in class org.apache.pdfbox.cos.COSName
 
REASONS - Static variable in class org.apache.pdfbox.cos.COSName
 
rebuildTrailer(XrefTrailerResolver, SecurityHandler<? extends ProtectionPolicy>) - Method in class org.apache.pdfbox.pdfparser.BruteForceParser
Rebuild the trailer dictionary if startxref can't be found.
RECIPIENTS - Static variable in class org.apache.pdfbox.cos.COSName
 
RECT - Static variable in class org.apache.pdfbox.cos.COSName
 
REFERENCE - Static variable in class org.apache.pdfbox.cos.COSName
 
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
refreshAppearances() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Refreshes the appearance streams and appearance dictionaries for the widget annotations of all fields.
refreshAppearances(List<PDField>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Refreshes the appearance streams and appearance dictionaries for the widget annotations of the specified fields.
registerHandler(String, Class<? extends SecurityHandler>, Class<? extends ProtectionPolicy>) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlerFactory
Registers a security handler.
registerTrueTypeFontForClosing(TrueTypeFont) - Method in class org.apache.pdfbox.pdmodel.PDDocument
For internal PDFBox use when creating PDF documents: register a TrueTypeFont to make sure it is closed when the PDDocument is closed to avoid memory leaks.
REGISTRY - Static variable in class org.apache.pdfbox.cos.COSName
 
REGISTRY_NAME - Static variable in class org.apache.pdfbox.cos.COSName
 
RELATIVE_COLORIMETRIC - Static variable in class org.apache.pdfbox.cos.COSName
 
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
remove(int) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Removes the page with the given index from the page tree.
remove(PDPage) - Method in class org.apache.pdfbox.pdmodel.PDPageTree
Removes the given page from the page tree.
remove(Object) - Method in class org.apache.pdfbox.util.SmallMap
 
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.
removeIssuer(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Removes an issuer from the issuers list
removeItem(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
This will remove an item for the dictionary.
removeKeyUsage(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
Removes a key usage extension
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.
removeObjectableKid(COSObjectable) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
Removes an objectable kid.
removeOID(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
removes an OID from the list
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.text.PDFTextStripperByArea
Delete a region to group text by.
removeSubject(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
removes a subject from the list
removeUserProperty(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Removes a user property.
removeV45filters() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
remove CF, StmF, and StrF entries.
RENAME - Static variable in class org.apache.pdfbox.cos.COSName
 
RenderDestination - Enum in org.apache.pdfbox.rendering
Optional content groups are visible depending on the render purpose.
renderImage(int) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB image at 72 DPI
renderImage(int, float) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB image at the given scale.
renderImage(int, float, ImageType) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB or ARGB image at the given scale.
renderImage(int, float, ImageType, RenderDestination) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB or ARGB image at the given scale.
renderImageWithDPI(int, float) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB image at the given DPI.
renderImageWithDPI(int, float, ImageType) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Returns the given page as an RGB image at the given DPI.
RenderingIntent - Enum in org.apache.pdfbox.pdmodel.graphics.state
Rendering intent.
RenderingMode - Enum in org.apache.pdfbox.pdmodel.graphics.state
Text Rendering Mode.
renderPageToGraphics(int, Graphics2D) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Renders a given page to an AWT Graphics2D instance at 72 DPI.
renderPageToGraphics(int, Graphics2D, float) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Renders a given page to an AWT Graphics2D instance.
renderPageToGraphics(int, Graphics2D, float, float) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Renders a given page to an AWT Graphics2D instance.
renderPageToGraphics(int, Graphics2D, float, float, RenderDestination) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Renders a given page to an AWT Graphics2D instance.
REPEAT - Static variable in class org.apache.pdfbox.cos.COSName
 
RES_FORK - Static variable in class org.apache.pdfbox.cos.COSName
 
reset() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Reset all data so that it can be used to rebuild the trailer.
resetTrailerResolver() - Method in class org.apache.pdfbox.pdfparser.COSParser
Indicates whether the xref trailer resolver should be reset or not.
ResourceCache - Interface in org.apache.pdfbox.pdmodel
A document-wide cache for page resources.
RESOURCES - Static variable in class org.apache.pdfbox.cos.COSName
 
RESTORE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
Restore - Class in org.apache.pdfbox.contentstream.operator.state
Q: Restore the graphics state.
Restore(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.Restore
 
restoreGraphicsStack(Deque<PDGraphicsState>) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Restores the entire graphics stack.
restoreGraphicsState() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Pops the current graphics state from the stack.
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
retrievePageNumber() - 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.
retrieveTrailer() - Method in class org.apache.pdfbox.pdfparser.COSParser
Read the trailer information and provide a COSDictionary containing the trailer information.
Revisions<T> - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
 
Revisions() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
Constructor.
RGB - Static variable in class org.apache.pdfbox.cos.COSName
 
RI - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
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
 
ROTATE - Static variable in class org.apache.pdfbox.cos.COSName
 
rotate(double) - Method in class org.apache.pdfbox.util.Matrix
Rotates this matrix by the given factors.
ROW_SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
 
ROWS - Static variable in class org.apache.pdfbox.cos.COSName
 
RP - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
RP
RT - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
RUN_LENGTH_DECODE_ABBREVIATION - Static variable in class org.apache.pdfbox.cos.COSName
 
RV - Static variable in class org.apache.pdfbox.cos.COSName
 

S

S - Static variable in class org.apache.pdfbox.cos.COSName
 
S - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
SA - Static variable in class org.apache.pdfbox.cos.COSName
 
SATURATION - Static variable in class org.apache.pdfbox.cos.COSName
 
SATURATION - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
SAVE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
Save - Class in org.apache.pdfbox.contentstream.operator.state
q: Save the graphics state.
Save(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.Save
 
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 using default compression.
save(File) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document to a file using default compression.
save(OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will save the document to an output stream.
save(File, CompressParameters) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document using the given compression.
save(String, CompressParameters) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document to a file using the given compression.
save(OutputStream, CompressParameters) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the document using the given compression.
saveGraphicsStack() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Saves the entire graphics stack.
saveGraphicsState() - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Pushes the current graphics state to the stack.
saveIncremental(OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the PDF as an incremental update.
saveIncremental(OutputStream, Set<COSDictionary>) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save the PDF as an incremental update.
saveIncrementalForExternalSigning(OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Save PDF incrementally without closing for external signature creation scenario.
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(float, float) - Method in class org.apache.pdfbox.util.Matrix
Scales this matrix by the given factors.
scale(float) - Method in class org.apache.pdfbox.util.Vector
Returns a new vector scaled by both x and y.
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.
Scaling - Enum in org.apache.pdfbox.printing
Scale of the image on printed pages.
SCHEMA - Static variable in class org.apache.pdfbox.cos.COSName
 
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
SCREEN - Static variable in class org.apache.pdfbox.cos.COSName
 
SCREEN - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
ScriptingHandler - Interface in org.apache.pdfbox.pdmodel.interactive.form
 
SE - Static variable in class org.apache.pdfbox.cos.COSName
 
SECT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Sect
securityHandler - Variable in class org.apache.pdfbox.pdfparser.COSParser
The security handler.
SecurityHandler<T_POLICY extends ProtectionPolicy> - Class in org.apache.pdfbox.pdmodel.encryption
A security handler as described in the PDF specifications.
SecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Constructor.
SecurityHandler(T_POLICY) - Constructor for class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Constructor used for encryption.
SecurityHandlerFactory - Class in org.apache.pdfbox.pdmodel.encryption
Manages security handlers for the application.
SecurityProvider - Class in org.apache.pdfbox.pdmodel.encryption
Singleton which provides a security provider.
SEPARATION - Static variable in class org.apache.pdfbox.cos.COSName
 
sequenceToName(String) - Method in class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Returns the name for a given sequence of Unicode characters.
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, E) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
set(FontMapper) - Static method in class org.apache.pdfbox.pdmodel.font.FontMappers
Sets the singleton FontMapper instance.
SET_CHAR_SPACING - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_F - Static variable in class org.apache.pdfbox.cos.COSName
 
SET_FF - Static variable in class org.apache.pdfbox.cos.COSName
 
SET_FLATNESS - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_FONT_AND_SIZE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_GRAPHICS_STATE_PARAMS - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_LINE_CAPSTYLE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_LINE_DASHPATTERN - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_LINE_JOINSTYLE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_LINE_MITERLIMIT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_LINE_WIDTH - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_MATRIX - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_RENDERINGINTENT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_TEXT_HORIZONTAL_SCALING - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_TEXT_LEADING - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_TEXT_RENDERINGMODE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_TEXT_RISE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SET_WORD_SPACING - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets AcroForm
setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the AcroForm 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
setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Set the merge mode to be used for merging AcroForms between documents PDFMergerUtility.AcroFormMergeMode
setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the action that is associated with this field.
setAction(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.PDTerminalField
Set the actions of the field.
setActions(PDDocumentCatalogAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets 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.text.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(String) - 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.multipdf.Overlay
Sets the all pages overlay file.
setAllPagesOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.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).
setAlphaConstant(double) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the stroke alpha constant property.
setAlphaSource(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the alpha source property.
setAlphaSourceFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the alpha source flag (“alpha is shape”), that specifies whether the current soft mask and alpha constant shall be interpreted as shape values (true) or opacity values (false).
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
Sets the alternate color space.
setAlternateColorSpaces(List<PDColorSpace>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
Sets the list of alternateColorSpace 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 ("shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to 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.
setAnnotationFilter(AnnotationFilter) - Method in class org.apache.pdfbox.rendering.PageDrawer
Set the AnnotationFilter.
setAnnotationFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the flags for this field.
setAnnotationIndex(int) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
This will set the index (zero-based) of the annotation in the /Annots array of the page specified by the /P entry.
setAnnotationName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
This will get the value of the /NM entry in the annotation dictionary.
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<FDFAnnotation>) - 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.
setAnnotationsFilter(AnnotationFilter) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Set the AnnotationFilter.
setAntiAlias(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
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.
setAppearanceState(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the annotations appearance state name.
setAppearanceStreamReference(FDFNamedPageReference) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the named page references.
setAppendOnly(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the AppendOnly bit.
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.text.PDFTextStripper
Sets the string which will be used at the end of an article.
setArticleStart(String) - Method in class org.apache.pdfbox.text.PDFTextStripper
Sets the string which will be used at the beginning of an article.
setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the ascent for the font.
setAttachmentName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set the name used to draw the attachment 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
Sets 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.state.PDExtendedGraphicsState
This will set the automatic stroke adjustment flag.
setAverageCharTolerance(float) - Method in class org.apache.pdfbox.text.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.
setB(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Sets the b value of the tristimulus.
setB(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
 
setBackground(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the background.
setBackground(PDColor) - 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.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
Sets the base color space.
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.form.PDFormXObject
This will set the BBox (bounding box) for this form.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will set the BBox (bounding box) for this Pattern.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the BBox (bounding box) for this Shading.
setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will set the rectangle specifying the location of the viewport.
setBefore(String) - 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.
setBitsPerComponent(int) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Set the number of bits per component.
setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.PDCIEDictionaryBasedColorSpace
This will set the BlackPoint tristimulus.
setBleedBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the BleedBox for this page.
setBlendMode(BlendMode) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
Set the blending mode.
setBlendMode(BlendMode) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the blend mode in the current graphics state
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.
setBorder(COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the border array.
setBorderColors(PDFourColours) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Sets the border colours for four sides separately (BorderColor).
setBorderColour(PDColor) - 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.fdf.FDFAnnotation
This will set the border effect dictionary, describing the effect applied to the border described by the BS entry.
setBorderEffect(PDBorderEffectDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will set the border effect dictionary, specifying effects to be applied when drawing the line.
setBorderEffect(PDBorderEffectDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will set the border effect dictionary, specifying effects to be applied when drawing the line.
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.
setBorderLine(float, PDBorderStyleDictionary, COSArray) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Convenience method for annotations: sets the line with and dash style.
setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
This will set the border style dictionary, specifying the width and dash pattern used in drawing the annotation.
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.PDAnnotationMarkup
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.
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.
setCalcOrder(List<PDField>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the calculation order in which field values should be recalculated when the value of any field changes.
setCallout(float[]) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will set the coordinates of the callout line.
setCallout(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will set the coordinates of the callout line.
setCanAssembleDocument(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
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.
setCanExtractForAccessibility(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
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.
setCanModify(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
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).
setCanPrint(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print.
setCanPrintFaithful(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
Set if the user can print the document in a faithful format or in a degraded format (if print is enabled).
setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the cap height for the font.
setCaption(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set if the contents are shown as a caption to the line.
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.fdf.FDFAnnotationLine
This will set the horizontal offset of the caption.
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.
setCaptionStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the caption positioning.
setCaptionVerticalOffset(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the vertical offset of the caption.
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.
setCharacterSpacing(float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Set the value of the characterSpacing.
SetCharSpacing - Class in org.apache.pdfbox.contentstream.operator.text
Tc: Set character spacing.
SetCharSpacing(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.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.
setChildren(List<PDField>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Sets the child fields.
setCIDSet(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set a stream containing a CIDSet.
setClassMap(Map<String, Object>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the ClassMap.
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 set the field flags that are associated with this field.
setClearFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the field flags that are associated with this field.
setClearWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the field flags that are associated with this field.
setClearWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the field flags that are associated with this field.
setClip() - Method in class org.apache.pdfbox.rendering.PageDrawer
Sets the clipping path using caching for performance.
SetColor - Class in org.apache.pdfbox.contentstream.operator.color
sc,scn,SC,SCN: Sets the color to use for stroking or non-stroking operations.
SetColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetColor
 
setColor(PDColor) - Method in class org.apache.pdfbox.contentstream.operator.color.SetColor
Sets either the stroking or non-stroking color value.
setColor(PDColor) - Method in class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColor
Sets the non-stroking color.
setColor(PDColor) - Method in class org.apache.pdfbox.contentstream.operator.color.SetStrokingColor
Sets the stroking color.
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.
setColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
This will set the color used in drawing various elements.
setColorantName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
Sets the colorant name.
setColorantNames(List<String>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
Sets the list of colorants
setColorants(Map<String, PDColorSpace>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
Sets the colorant map.
setColorSpace(PDColorSpace) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets the color space for this image.
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the color space for the shading.
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.PDTextField
Set the comb bit.
setCombo(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the Combo bit.
setCommitOnSelChange(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the CommitOnSelChange 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 provided by the signer to enable a recipient to contact the signer to verify the signature, e.g.
setContents(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the contents, or a description, for an annotation.
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.
setContents(List<PDStream>) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the contents of this page.
setConversionFactor(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
This will set the conversion factor.
setCoords(float[]) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationTextMarkup
Set the coordinates of individual words or group of words.
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 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.
setCryptFilterDictionary(COSName, PDCryptFilterDictionary) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the crypt filter with the given name.
setCryptFilterMethod(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
This will set the crypt filter method.
setCurrentAccessPermission(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Sets the access permissions.
setCurrentTransformationMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Set the value of the CTM.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSound
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
Set a custom appearance handler for generating the annotations appearance streams.
setCustomAppearanceHandler(PDAppearanceHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline
Set a custom appearance handler for generating the annotations appearance streams.
setCustomMetadataValue(String, String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
Set the custom metadata value.
setCustomSecureRandom(SecureRandom) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Set the custom SecureRandom.
setCYX(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
This will set the CYX factor.
setD(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.PDActionRemoteGoTo
This will set the destination to jump to.
setD(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
 
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.
setDashStyle(COSArray) - 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.
setDecode(COSArray) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets the decode array.
setDecode(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setDecode(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
setDecodedStreamLength(int) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
Set the decoded stream length.
setDecodeParms(List<?>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the list of decode parameters.
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
Sets the decryption certificate
setDecryptMetadata(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Set whether to decrypt meta data.
setDefaultAppearance(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Set the default appearance string.
setDefaultAppearance(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Set the default appearance.
setDefaultAppearance(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the default appearance.
setDefaultAppearance(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the default appearance.
setDefaultAppearanceString(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
This will set the default appearance string.
setDefaultCryptFilterDictionary(PDCryptFilterDictionary) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the default crypt filter (for public-key security handler).
setDefaultDestination(RenderDestination) - Method in class org.apache.pdfbox.rendering.PDFRenderer
 
setDefaultOverlayFile(String) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the default overlay file.
setDefaultOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.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.
setDefaultStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
Set the default style string.
setDefaultStyleString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
Set the default style string.
setDefaultStyleString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the default style string.
setDefaultValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Sets the default value.
setDefaultValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Sets the default value of this field.
setDefaultValue(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Sets the default of this field.
setDefaultValue(PDSignature) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Sets the default value of this field to be the given signature.
setDefaultValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
Sets the default value of this field.
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.
setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
This will set the destination to jump to.
setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
setDestinationDocumentInformation(PDDocumentInformation) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
setDestinationFileName(String) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Set the name of the destination file.
setDestinationMetadata(PDMetadata) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
setDestinationStream(OutputStream) - Method in class org.apache.pdfbox.multipdf.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<String>) - 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.
setDimension(PDTransitionDimension) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
Sets the dimension in which the specified transition effect shall occur.
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.
setDirection(PDTransitionDirection) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
Sets the direction in which the specified transition effect shall move.
setDirectory(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
setDoc(Map<String, PDActionJavaScript>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
Sets the dictionary's "Doc" entry.
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
Sets the document ID to the given value.
setDocumentInformation(PDDocumentInformation) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will set the document information for this document.
setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Set the merge mode to be used for merging documents PDFMergerUtility.DocumentMergeMode
setDocumentOutline(PDDocumentOutline) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets 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.PDTextField
Set the doNotScroll bit.
setDoNotSpellCheck(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the DoNotSpellCheck bit.
setDoNotSpellCheck(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
Set the doNotSpellCheck bit.
setDownAppearance(PDAppearanceEntry) - 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.text.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.
setDuration(float) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
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.
setEdit(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDComboBox
Set the Edit bit.
setElementIdentifier(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
Sets the element identifier (ID).
setEmbeddedDate(COSName, COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
Set the date object.
setEmbeddedFDFs(List<PDFileSpecification>) - 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.
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.
setEmbeddedInt(COSName, 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(COSName, 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.
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(PDEncryption) - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will set the encryption dictionary for this document.
setEncryptionKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Sets the current encryption key data.
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.
setEncryptMetaData(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
Set the EncryptMetaData dictionary info.
setEndBookmark(PDOutlineItem) - Method in class org.apache.pdfbox.text.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.multipdf.PageExtractor
Sets the last page number to be extracted.
setEndPage(int) - Method in class org.apache.pdfbox.multipdf.Splitter
This will set the end page.
setEndPage(int) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will set the last page to be extracted by this class.
setEndPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the line ending style for the end point, see the LE_ constants for the possible values.
setEndPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will set the line ending style for the end point, see the LE_ constants for the possible values.
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.
setEndPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
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.COSParser
Sets how many trailing bytes of PDF file are searched for EOF marker and 'startxref' marker.
setEvenPageOverlayFile(String) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the even page overlay file.
setEvenPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the even page overlay PDF.
setExecuteParam(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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).
setExportValues(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
This will set the export values.
setExportValues(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
 
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.PDShadingPattern
This will set the external 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(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This will set the file name to be launched or the document to be opened or printed, in standard Windows pathname format.
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.
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 set the field flags that are associated with this field.
setFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set 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<FDFField>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of fields.
setFields(List<FDFField>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will set a list of fields for this template.
setFields(COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm
 
setFields(COSArray) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
 
setFields(List<PDField>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the documents root fields.
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.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.PDActionEmbeddedGoTo
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.PDActionRemoteGoTo
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
This will set the file in which the destination is located.
setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
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.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.
setFileFilters(List<String>) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will set the filters that are part of this stream.
setFilename(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Sets the name of the file as found in the EmbeddedFiles name tree.
setFilename(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
Set the file to launch.
setFileSelect(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
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 the unicode file name.
setFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
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.
setFilterRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the filter shall be required.
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<String>) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
Sets which filters are applied to 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.
setFirstPageOverlayFile(String) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the first page overlay file.
setFirstPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.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(COSName, int, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
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.interactive.action.PDActionResetForm
 
setFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
 
SetFlatness - Class in org.apache.pdfbox.contentstream.operator.state
i: Set the flatness tolerance.
SetFlatness(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetFlatness
 
setFlatness(double) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the flatness property.
setFlatnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set 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[].
setFlyAreaOpaque(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
setFlyScale(float) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
 
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) - 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.graphics.state.PDTextState
Set the value of the font.
setFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.AppearanceStyle
Set the font to be used for text formatting.
SetFontAndSize - Class in org.apache.pdfbox.contentstream.operator.text
Tf: Set text font and size.
SetFontAndSize(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetFontAndSize
 
setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set the fonts bounding box.
setFontDescriptor(PDFontDescriptor) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Sets the font descriptor when embedding a font.
setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font family.
setFontFile(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set the type 1 font program.
setFontFile2(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set the true type font program.
setFontFile3(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
Set a stream containing a font program that is not true type or type 1.
setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font name.
setFontSetting(PDFontSetting) - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.graphics.state.PDTextState
Set the value of the fontSize.
setFontSize(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.AppearanceStyle
Set the font size to be used for formatting.
setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will set the font stretch.
setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
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
Sets whether to force the string is to be written in hex form.
setFormattedValue(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
Sets the string for the property value.
setFormatterRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets formatter rectangle
setFormType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
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.
setFringe(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
This will set the fringe rectangle.
setFringe(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
This will set the fringe rectangle.
setFringe(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will set the fringe rectangle.
setFringe(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
This will set the fringe rectangle.
setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the function for the color conversion.
setFunction(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the functions COSArray for the color conversion.
setG(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
Sets 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
Sets the gamma value.
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).
SetGraphicsStateParameters - Class in org.apache.pdfbox.contentstream.operator.state
gs: Set parameters from graphics state parameter dictionary.
SetGraphicsStateParameters(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetGraphicsStateParameters
 
setGroupEnabled(String, boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Enables or disables all optional content groups with the given name.
setGroupEnabled(PDOptionalContentGroup, boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
Enables or disables an optional content group.
setGuideLineColor(PDColor) - 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.
setH(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
 
setHasHybridXRef() - Method in class org.apache.pdfbox.cos.COSDocument
Marks the pdf as document using hybrid cross references.
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).
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 interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets the height of the image.
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.
setHighestXRefObjectNumber(long) - Method in class org.apache.pdfbox.cos.COSDocument
Internal PDFBox use only.
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
Sets the highest value that is allowed.
setHolderForm(PDFormXObject) - 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
setHorizontalScaling(float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Set the value of the horizontalScaling.
setIcon(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
This will set the icon (and hence appearance, AP taking precedence) For this annotation.
setIconFit(FDFIconFit) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the icon fit 'IF' entry.
setID(COSArray) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the FDF id.
setIDTree(PDNameTreeNode<PDStructureElement>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
Sets the ID tree.
setIgnoreAcroFormErrors(boolean) - Method in class org.apache.pdfbox.multipdf.PDFMergerUtility
Set to true to ignore acroform errors.
setImage(PDImageXObject) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets the image of visible signature
setImageData(byte[]) - Method in class org.apache.pdfbox.contentstream.operator.Operator
This will set the image data, this is only used for the ID operator.
setImageDownscalingOptimizationThreshold(float) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Set the image downscaling optimization threshold.
setImageForm(PDFormXObject) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets Image form.
setImageFormName(COSName) - 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(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets visible signature image name
setImageParameters(COSDictionary) - Method in class org.apache.pdfbox.contentstream.operator.Operator
This will set the image parameters, this is only valid for BI operators.
setIndentThreshold(float) - Method in class org.apache.pdfbox.text.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.
setInfo(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
setInkList(List<float[]>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
Set the paths making up the freehand "scribble".
setInkList(float[][]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
Sets the paths that make this annotation.
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(PDFormXObject) - 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(COSName) - 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.multipdf.Overlay
Sets the file to be overlaid.
setInputPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the PDF to be overlaid.
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.fdf.FDFAnnotation
The intent of the annotation.
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.
setInteriorColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
This will set interior color of the drawn area.
setInteriorColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set interior color of the line endings defined in the LE entry.
setInteriorColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
This will set interior color of the drawn area.
setInteriorColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will set interior color of the line endings defined in the LE entry.
setInteriorColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
This will set interior color of the drawn area.
setInteriorColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
This will set interior color of the line endings defined in the LE entry.
setInteriorColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will set interior color.
setInteriorColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
This will set interior color of the line endings defined in the LE entry.
setInteriorColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set interior color of the drawn area color is in DeviceRGB colorspace.
setInterpolate(boolean) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets the Interpolate flag, true for high-quality image scaling.
setInterpolate(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setInterpolate(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
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.
setIssuer(List<byte[]>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional) A list of array of bytes containing DER-encoded X.509v3 certificates of acceptable issuers.
setIssuerRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if Issuer shall be required as a constraint on signature.
setIsXRefStream(boolean) - Method in class org.apache.pdfbox.cos.COSDocument
Sets isXRefStream to the given value.
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.
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.
setJustification(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will set the form of quadding (justification) of the annotation text.
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(COSObjectKey) - Method in class org.apache.pdfbox.cos.COSBase
Set the COSObjectKey of an indirect object.
setKeyLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Setter of the property keyLength.
setKeyUsage(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional; PDF 1.7) A List of ASCII strings, where each string specifies an acceptable key-usage extension that must be present in the signing certificate.
setKeyUsageRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if KeyUsage shall be required as a constraint on signature.
setKeywords(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the keywords of the document.
setKids(List<? extends PDNameTreeNode<T>>) - 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.
setKnockoutFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.
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
Sets the Language for the document.
setLastPageOverlayFile(String) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the last page overlay file.
setLastPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the last page overlay PDF.
setLeaderExtend(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the length of the leader line extensions.
setLeaderLength(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the length of the leader line.
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.
setLeaderOffset(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
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.graphics.state.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.PDEncryption
This will set the number of bits to use for the encryption algorithm.
setLenient(boolean) - Method in class org.apache.pdfbox.pdfparser.COSParser
Change the parser leniency flag.
setLine(float[]) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set start and end coordinates of the line (or leader line if LL entry is set).
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).
setLineCap(int) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the line cap.
SetLineCapStyle - Class in org.apache.pdfbox.contentstream.operator.state
J: Set the line cap style.
SetLineCapStyle(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetLineCapStyle
 
setLineCapStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the line cap style for the graphics state.
SetLineDashPattern - Class in org.apache.pdfbox.contentstream.operator.state
d: Set the line dash pattern.
SetLineDashPattern(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetLineDashPattern
 
setLineDashPattern(COSArray, int) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
setLineDashPattern(COSArray) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
Set the line dash pattern associated with this box style.
setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the dash pattern for the graphics state.
setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will set the current line dash pattern.
setLineEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
This will set the line ending style.
setLineEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will set the line ending style.
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.state.PDGraphicsState
Get the value of the line join.
SetLineJoinStyle - Class in org.apache.pdfbox.contentstream.operator.state
j: Set the line join style.
SetLineJoinStyle(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetLineJoinStyle
 
setLineJoinStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the line join style.
SetLineMiterLimit - Class in org.apache.pdfbox.contentstream.operator.state
M: Set miter limit.
SetLineMiterLimit(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetLineMiterLimit
 
setLineSeparator(String) - Method in class org.apache.pdfbox.text.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.
SetLineWidth - Class in org.apache.pdfbox.contentstream.operator.state
w: Set line width.
SetLineWidth(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetLineWidth
 
setLineWidth(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the line width.
setLineWidth(float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the line width.
setLineWidthOnDemand(float) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Sets the line width.
setListItemPatterns(List<Pattern>) - Method in class org.apache.pdfbox.text.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 CPU host name or physical location of the signing.
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.
setLockedContents(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Set the LockedContents flag.
setLockedContents(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Set the LockedContents 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.
setLowerLeftX(float) - Method in class org.apache.pdfbox.pdmodel.common.PDImmutableRectangle
This will set the lower left x coordinate.
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.PDImmutableRectangle
This will set the lower left y 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.
setMappingName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
This will set the mapping name of the field.
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 - Class in org.apache.pdfbox.contentstream.operator.state
Tm: Set text matrix and text line matrix.
SetMatrix(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetMatrix
 
setMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
Sets the linear interpretation matrix.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Sets the optional Matrix entry for the form XObject.
setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
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.
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.PDTextField
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.
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.
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
Sets the metadata stream that is associated with this color space.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Sets the metadata associated with this XObject, or null if there is none.
setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets 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.
setMiterLimit(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the miter limit for the graphics state.
setMiterLimit(float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the miter limit.
setMix(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
The flag specifying whether to mix this sound with any other sound already playing.
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.
setMotion(PDTransitionMotion) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransition
Sets the direction of motion for the specified transition effect.
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.PDTextField
Set the multiline bit.
setMultiSelect(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the MultiSelect bit.
setN(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.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 of the person or authority signing the document.
setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
This will set the name of the viewport.
setNamedDestination(PDNamedDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
This will set a named destination in the current document that provides the page number of the file attachment annotation.
setNamedDestination(String) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
Set the named destination.
setNames(Map<String, T>) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
Set the names for this node.
setNames(PDDocumentNameDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the names dictionary for the document.
setNeedAppearances(Boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the NeedAppearances value.
setNeedToBeUpdated(boolean) - Method in interface org.apache.pdfbox.cos.COSUpdateInfo
Set the update state of the dictionary for the COSWriter.
setNext(List<PDAction>) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
setNoExport(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
sets the field to be not exported.
setNonEFontNoWarn(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
If true, the reader should not display a warning about fonts not being embedded.
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.
setNonStrokeAlphaConstant(double) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the non-stroke alpha constant property.
setNonStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the non stroking alpha constant.
SetNonStrokingColor - Class in org.apache.pdfbox.contentstream.operator.color
sc: Sets the colour to use for non-stroking operations.
SetNonStrokingColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColor
 
setNonStrokingColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the non-stroking color.
setNonStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Set the non stroking color.
SetNonStrokingColorN - Class in org.apache.pdfbox.contentstream.operator.color
scn: Sets the colour to use for non-stroking operations.
SetNonStrokingColorN(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColorN
 
setNonStrokingColorOnDemand(PDColor) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Set the non stroking color.
SetNonStrokingColorSpace - Class in org.apache.pdfbox.contentstream.operator.color
cs: Sets the non-stroking color space.
SetNonStrokingColorSpace(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingColorSpace
 
setNonStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the non-stroking color space.
SetNonStrokingDeviceCMYKColor - Class in org.apache.pdfbox.contentstream.operator.color
k: Set the non-stroking colour space to DeviceCMYK and set the colour to use for non-stroking operations.
SetNonStrokingDeviceCMYKColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceCMYKColor
 
SetNonStrokingDeviceGrayColor - Class in org.apache.pdfbox.contentstream.operator.color
g: Set the non-stroking colour space to DeviceGray and set the gray level to use for non-stroking operations.
SetNonStrokingDeviceGrayColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceGrayColor
 
SetNonStrokingDeviceRGBColor - Class in org.apache.pdfbox.contentstream.operator.color
rg: Set the non-stroking colour space to DeviceRGB and set the colour to use for non-stroking operations.
SetNonStrokingDeviceRGBColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetNonStrokingDeviceRGBColor
 
setNonStrokingOverprint(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the non stroking overprint property.
setNonStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the overprint control(OP).
setNonSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setNormalAppearance(PDAppearanceEntry) - 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(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.
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 numbers for this node.
setO(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
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.
setOCGs(List<PDPropertyList>) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
Set optional content groups as a list.
setOCProperties(PDOptionalContentProperties) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the optional content properties dictionary.
setOddPageOverlayFile(String) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the odd page overlay file.
setOddPageOverlayPDF(PDDocument) - Method in class org.apache.pdfbox.multipdf.Overlay
Sets the odd page overlay PDF.
setOID(List<byte[]>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional) A list of byte arrays that contain Object Identifiers (OIDs) of the certificate policies that must be present in the signing certificate.
setOIDRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if OID shall be required as a constraint on signature.
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 the initial 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
Sets the Document Open Action for this object.
setOpenInNewWindow(OpenMode) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
This will specify whether to open the destination document in a new window.
setOpenInNewWindow(OpenMode) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This will specify whether to open the destination document in a new window.
setOpenInNewWindow(OpenMode) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
This will specify whether to open the destination document in a new window.
setOperation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.
setOptionalContent(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
Sets the optional content group or optional content membership dictionary.
setOptionalContent(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Sets the optional content group or optional content membership dictionary.
setOptionalContent(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
Sets the optional content group or optional content membership dictionary for the annotation.
setOptions(List<Object>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the options for the choice field.
setOptions(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will set the display values - the 'Opt' key.
setOptions(List<String>, List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will set the display and export values - the 'Opt' key.
setOriginDocumentState(COSDocumentState) - Method in class org.apache.pdfbox.cos.COSUpdateState
Links the given COSDocumentState to the COSUpdateState.updated state of the managed COSUpdateState.updateInfo.
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
 
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.multipdf.Overlay
Sets the overlay position.
setOverprint(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the overprint property.
setOverprintMode(Integer) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the overprint mode(OPM).
setOverprintMode(int) - Method in class org.apache.pdfbox.pdmodel.graphics.state.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.
setOwnerEncryptionKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the OE entry in the standard encryption dictionary.
setOwnerKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the O entry in the standard encryption dictionary.
setOwnerPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Sets the owner password
setP(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.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.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 0-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 a local destination.
setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
Set the page that this bead is part of.
setPageEnd(String) - Method in class org.apache.pdfbox.text.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
Sets the page label descriptor for the document.
setPageLayout(PageLayout) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the page layout.
setPageMode(PageMode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the page mode.
setPageNumber(int) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Set the page number (zero-based) in the current document containing the file attachment annotation.
setPageNumber(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
Set the page number for a remote destination.
setPages(List<FDFPage>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the list of pages.
setPageStart(String) - Method in class org.apache.pdfbox.text.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.PDAbstractPattern
This will set the paint type.
setPaintType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will set the paint type.
setParagraphEnd(String) - Method in class org.apache.pdfbox.text.PDFTextStripper
Sets the string which will be used at the end of a paragraph.
setParagraphStart(String) - Method in class org.apache.pdfbox.text.PDFTextStripper
Sets the string which will be used at the beginning of a paragraph.
setParent(PDNameTreeNode<T>) - 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(PDTerminalField) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
Set the parent field of a widget annotation.
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.
setParsing(boolean) - Method in class org.apache.pdfbox.cos.COSDocumentState
Sets the COSDocumentState.parsing state of the document.
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.PDTextField
Set the password bit.
setPatternType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
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.
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 PDSignatureField
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.PDEncryption
This will set the permissions bit mask.
setPermissions(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Sets the access permissions
setPerms(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Set the Perms entry in the encryption dictionary.
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.
setPreferAES(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
Set whether AES encryption is preferred when several encryption methods are available for the chosen key length.
setPreferredSignatureSize(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.
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(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
Set the PrintArea preference.
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.
setProtectionPolicy(T_POLICY) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Sets the ProtectionPolicy to the given value.
setProvider(Provider) - Static method in class org.apache.pdfbox.pdmodel.encryption.SecurityProvider
Set the provider to be used for advanced encrypting/decrypting.
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.annotation.PDAnnotationFreeText
This will set the quadding/justification of the text.
setQ(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will set the document-wide default value for the quadding/justification of variable text fields.
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
Sets the r value of the tristimulus.
setRadiosInUnison(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton
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
Sets the 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.
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 for the signing, such as (I agree...).
setReasonRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the Reason shall be required.
setReasons(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.PDEncryption
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.PDAnnotationFreeText
This will set the rectangle difference rectangle.
setRectDifference(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the rectangle difference rectangle.
setRectDifferences(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
This will set the difference between the annotations "outer" rectangle defined by /Rect and boundaries of the underlying.
setRectDifferences(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
setRectDifferences(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
setRectDifferences(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFreeText
This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
setRectDifferences(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
setRectDifferences(float, float, float, float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
This will set the difference between the annotations "outer" rectangle defined by /Rect and the border.
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
 
setRelationship(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Set the relationship between the current document and the target (which may be an intermediate target).
setRename(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
This will set if the fields can be renamed.
setRenderingHints(RenderingHints) - Method in class org.apache.pdfbox.printing.PDFPageable
Set the rendering hints.
setRenderingHints(RenderingHints) - Method in class org.apache.pdfbox.printing.PDFPrintable
Set the rendering hints.
setRenderingHints(RenderingHints) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Set the rendering hints.
SetRenderingIntent - Class in org.apache.pdfbox.contentstream.operator.state
ri: Set the rendering intent.
SetRenderingIntent(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.state.SetRenderingIntent
 
setRenderingIntent(String) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the rendering intent for the graphics state.
setRenderingIntent(RenderingIntent) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will set the rendering intent.
setRenderingMode(RenderingMode) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Set the value of the renderingMode.
setRepeat(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
A flag specifying whether to repeat the sound indefinitely.
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 flag whether the field is to be required to have a value at the time it is exported by a submit-form action.
setResourceCache(ResourceCache) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Sets the resource cache associated with this document.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.form.PDFormXObject
This will set the resources for this page.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will set the resources for this pattern.
setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.PDPage
This will set the resources for this page.
setRevision(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the R entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.14.
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(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
This will set the rich text stream which is displayed in the popup window.
setRichContents(String) - 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(COSString) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the rich text value.
setRichText(COSStream) - 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.PDTextField
Set the richText bit.
setRichTextValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Set the fields rich text value.
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.graphics.state.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(PDAppearanceEntry) - 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.fdf.FDFAnnotationFreeText
This will set the clockwise rotation in degrees.
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.
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).
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.
setScriptingHandler(ScriptingHandler) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set a handler to support JavaScript actions in the form.
setSecurityHandler(SecurityHandler<ProtectionPolicy>) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the security handler used in this encryption dictionary
setSeedValue(PDSeedValue) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
(Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.
setSeedValueCertificate(PDSeedValueCertificate) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
(Optional) A certificate seed value dictionary containing information about the certificate to be used when signing.
setSelectedOptionsIndex(List<Integer>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
This will set the indices of the selected options - the 'I' key.
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 set the field flags that are associated with this field.
setSetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the field flags that are associated with this field.
setSetWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the widget field flags that are associated with this field.
setSetWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the widget field flags that are associated with this field.
setShading(PDShading) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPattern
This will set the shading resources for this pattern.
setShadingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
This will set the shading type.
setShouldSeparateByBeads(boolean) - Method in class org.apache.pdfbox.text.PDFTextStripper
Set if the text stripper should group the text output by a list of beads.
setShouldSeparateByBeads(boolean) - Method in class org.apache.pdfbox.text.PDFTextStripperByArea
This method does nothing in this derived class, because beads and regions are incompatible.
setSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
This will set the signature that is associated with this catalog.
setSignature(byte[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.ExternalSigningSupport
Set CMS signature bytes to PDF.
setSignature(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SigningSupport
 
setSignatureField(PDSignatureField) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets signature field
setSignatureRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Sets SignatureRectangle
setSignaturesExist(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
Set the SignaturesExist bit.
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.state.PDGraphicsState
set the value of the smoothness property.
setSmoothnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the smoothness tolerance.
setSoftMask(PDSoftMask) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the current soft mask
setSort(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the Sort bit.
setSortByPosition(boolean) - Method in class org.apache.pdfbox.text.PDFTextStripper
The order of the text tokens in a PDF file may not be in the same as they appear visually on the screen.
setSound(COSStream) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Sets the sound object.
setSourceRegion(Rectangle) - Method in class org.apache.pdfbox.filter.DecodeOptions
Sets the region of the source image that should be decoded.
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.text.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.multipdf.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.text.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.multipdf.PageExtractor
Sets the first page number to be extracted.
setStartPage(int) - Method in class org.apache.pdfbox.multipdf.Splitter
This will set the start page.
setStartPage(int) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will set the first page to be extracted by this class.
setStartPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
This will set the line ending style for the start point, see the LE_ constants for the possible values.
setStartPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will set the line ending style for the start point, see the LE_ constants for the possible values.
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.
setStartPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
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.fdf.FDFAnnotationText
This will set the annotation state.
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.fdf.FDFAnnotationText
This will set the annotation state model.
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.
setStdCryptFilterDictionary(PDCryptFilterDictionary) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the standard crypt filter.
setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
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.
setStencil(boolean) - Method in interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets whether or not the image is a stencil.
setStencil(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setStencil(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
setStreamCacheCreateFunction(RandomAccessStreamCache.StreamCacheCreateFunction) - Method in class org.apache.pdfbox.multipdf.Splitter
Set the current function to be used to create an instance of stream cache.
setStreamFilterName(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the name of the filter which is used for de/encrypting streams.
setStreamFilterName(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Set the stream filter name.
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.
setStringFilterName(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
Sets the name of the filter which is used for de/encrypting strings.
setStringFilterName(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
Set the string filter name.
setStrokeAdjustment(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
set the value of the stroke adjustment.
setStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the stroking alpha constant.
SetStrokingColor - Class in org.apache.pdfbox.contentstream.operator.color
SC: Sets the colour to use for stroking stroking operations.
SetStrokingColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingColor
 
setStrokingColor(PDColor) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the stroking color.
setStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Set the stroking color.
SetStrokingColorN - Class in org.apache.pdfbox.contentstream.operator.color
SCN: Sets the colour to use for stroking stroking operations.
SetStrokingColorN(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingColorN
 
setStrokingColorOnDemand(PDColor) - Method in class org.apache.pdfbox.pdmodel.PDAppearanceContentStream
Set the stroking color.
SetStrokingColorSpace - Class in org.apache.pdfbox.contentstream.operator.color
CS: Set color space for stroking operations.
SetStrokingColorSpace(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingColorSpace
 
setStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
Sets the stroking color space.
SetStrokingDeviceCMYKColor - Class in org.apache.pdfbox.contentstream.operator.color
K: Set the stroking colour space to DeviceCMYK and set the colour to use for stroking operations.
SetStrokingDeviceCMYKColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceCMYKColor
 
SetStrokingDeviceGrayColor - Class in org.apache.pdfbox.contentstream.operator.color
G: Set the stroking colour space to DeviceGray and set the gray level to use for stroking operations.
SetStrokingDeviceGrayColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceGrayColor
 
SetStrokingDeviceRGBColor - Class in org.apache.pdfbox.contentstream.operator.color
RG: Set the stroking colour space to DeviceRGB and set the colour to use for stroking operations.
SetStrokingDeviceRGBColor(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.color.SetStrokingDeviceRGBColor
 
setStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the overprint control(OP).
setStructParent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
Sets the key of 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.form.PDFormXObject
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.
setStructureElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
Sets the structure element.
setStructureElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the structure element for this node.
setStructureTreeRoot(PDStructureTreeRoot) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets 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.PDEncryption
Set the subfilter entry of the encryption dictionary.
setSubFilter(List<String>) - 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(List<byte[]>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional) A list of byte arrays containing DER-encoded X.509v3 certificates that are acceptable for signing.
setSubject(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
This will set the subject of the document.
setSubjectDN(List<Map<String, String>>) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional; PDF 1.7) A list of maps, where each map contains key value pairs, that specify the Subject Distinguished Name (DN) that must be present within the certificate for it to be acceptable for signing.
setSubjectDNRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if subject DN shall be required as a constraint on signature.
setSubjectRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if subject shall be required as a constraint on signature.
setSubsamplingAllowed(boolean) - Method in class org.apache.pdfbox.printing.PDFPageable
Sets a value instructing the renderer whether it is allowed to subsample images before drawing.
setSubsamplingAllowed(boolean) - Method in class org.apache.pdfbox.printing.PDFPrintable
Sets a value instructing the renderer whether it is allowed to subsample images before drawing.
setSubsamplingAllowed(boolean) - Method in class org.apache.pdfbox.rendering.PDFRenderer
Sets a value instructing the renderer whether it is allowed to subsample images before drawing.
setSubsamplingOffsetX(int) - Method in class org.apache.pdfbox.filter.DecodeOptions
Sets the horizontal subsampling offset for decoding images
setSubsamplingOffsetY(int) - Method in class org.apache.pdfbox.filter.DecodeOptions
Sets the vertical subsampling offset for decoding images
setSubsamplingX(int) - Method in class org.apache.pdfbox.filter.DecodeOptions
Sets the number of columns to advance in the source for every pixel decoded
setSubsamplingY(int) - Method in class org.apache.pdfbox.filter.DecodeOptions
Sets the number of rows to advance in the source for every pixel decoded
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.PDAction
This will set the type of action that the actions dictionary describes.
setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
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.text.PDFMarkedContentExtractor
By default the class will attempt to remove text that overlaps each other.
setSuppressDuplicateOverlappingText(boolean) - Method in class org.apache.pdfbox.text.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.
setSymbol(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
This will set the symbol that shall be associated with the caret.
setSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
A convenience method that sets the flag bit.
setSynchronous(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
A flag specifying whether to play the sound synchronously or asynchronously.
setT(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
 
setTarget(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
This will set the target frame in the browser to open this document.
setTargetDirectory(PDTargetDirectory) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
Sets the target directory.
setTargetDirectory(PDTargetDirectory) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDTargetDirectory
Sets the target directory.
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).
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<FDFTemplate>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
A list of FDFTemplate objects.
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(PDColor) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the RGB text color for this node.
setTextColor(Color) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
Set the RGB 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).
SetTextHorizontalScaling - Class in org.apache.pdfbox.contentstream.operator.text
Tz: Set horizontal text scaling.
SetTextHorizontalScaling(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetTextHorizontalScaling
 
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.state.PDExtendedGraphicsState
This will set the text knockout flag.
SetTextLeading - Class in org.apache.pdfbox.contentstream.operator.text
TL: Set text leading.
SetTextLeading(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetTextLeading
 
setTextLineMatrix(Matrix) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
setTextLineMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
setTextMatrix(Matrix) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
 
setTextMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
 
SetTextRenderingMode - Class in org.apache.pdfbox.contentstream.operator.text
Tr: Set text rendering mode.
SetTextRenderingMode(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetTextRenderingMode
 
SetTextRise - Class in org.apache.pdfbox.contentstream.operator.text
Ts: Set text rise.
SetTextRise(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetTextRise
 
setTextState(PDTextState) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will set the graphics text state.
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<PDThread>) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the list of threads for this pdf document.
setTilingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
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
Sets 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.
setToNull() - Method in class org.apache.pdfbox.cos.COSObject
Sets the referenced object to COSNull and removes the initially assigned parser.
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.
setTopIndex(Integer) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDListBox
This will set top index "TI" value.
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.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.
setTransfer(COSBase) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the transfer function of the /TR dictionary.
setTransfer(COSBase) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
This will set the transfer function.
setTransfer2(COSBase) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDExtendedGraphicsState
This will set the transfer function of the /TR2 dictionary.
setTransition(PDTransition) - Method in class org.apache.pdfbox.pdmodel.PDPage
 
setTransition(PDTransition, float) - Method in class org.apache.pdfbox.pdmodel.PDPage
Convenient method to set a transition and the display duration
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.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.PDImmutableRectangle
This will set the upper right x coordinate.
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.PDImmutableRectangle
This will set the upper right y 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.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
Sets the document level URI.
setURL(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional) A URL, the use for which is defined by the URLType entry.
setURL(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueTimeStamp
Sets the URL.
setURLRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
set true if URL shall be required as a constraint on signature.
setURLType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValueCertificate
(Optional; PDF 1.7) A name indicating the usage of the URL entry.
setUserEncryptionKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the UE entry in the standard encryption dictionary.
setUserKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the U entry in the standard encryption dictionary.
setUserPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
Sets the user password.
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.
setUserUnit(float) - Method in class org.apache.pdfbox.pdmodel.PDPage
Get the user unit.
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(byte[]) - Method in class org.apache.pdfbox.cos.COSString
Deprecated.
to be removed in a future release.
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 a String, or a List<String> to set the value.
setValue(COSBase) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
Sets the COS value of this field.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Set the selected option given its name, and try to update the visual appearance.
setValue(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDButton
Set the selected option given its index, and try to update the visual appearance.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Set the selected value of this field, and try to update the visual appearance.
setValue(List<String>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoice
Sets the entry "V" to the given values.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
Sets the value of the field.
setValue(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Sets the value of this field.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDNonTerminalField
Sets the plain text value of this field.
setValue(PDSignature) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
Sets the value of this field to be the given signature.
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
This will throw an UnsupportedOperationException if used as the signature fields value can't be set using a String
setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTextField
Set the plain text value of this field, and try to update the visual appearance.
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 header version of this PDF document.
setVersion(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
This will set the V entry of the encryption dictionary.

See PDF Reference 1.4 Table 3.13.
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(float) - Method in class org.apache.pdfbox.pdmodel.PDDocument
Sets the PDF specification version for this document.
setVersion(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the PDF specification version this document conforms to.
setVertices(float[]) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
This will set the coordinates of the vertices.
setVertices(float[]) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
This will set the coordinates of the the vertices.
setVertices(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolygon
This will set the numbers that shall represent the alternating horizontal and vertical coordinates.
setVertices(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
This will set the numbers that shall represent the alternating horizontal and vertical coordinates.
setVerticesPerRow(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
Set the number of vertices per row.
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.
setViewerPreferences(PDViewerPreferences) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Sets the viewer preferences.
setViewports(List<PDViewportDictionary>) - Method in class org.apache.pdfbox.pdmodel.PDPage
Set the viewports.
setVisibilityPolicy(COSName) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentMembershipDictionary
Sets the visibility policy name.
setVisibleSignature(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets configuration object of visible signature
setVisualSignature(File) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
Reads the visual signature from the given file.
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.
setVolume(float) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
Gets the volume at which to play the sound, in the range −1.0 to 1.0.
setVRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue
set true if the V entry shall be required.
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.PDCIEDictionaryBasedColorSpace
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 set the widget field flags that are associated with this field.
setWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
This will set the field flags that are associated with this field.
setWidgets(List<PDAnnotationWidget>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField
Sets the field's widget annotations.
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 interface org.apache.pdfbox.pdmodel.graphics.image.PDImage
Sets the width of the image.
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
 
setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
setWidth(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
This will set the border width in points, 0 = no border.
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.
setWinLaunchParams(PDWindowsLaunchParams) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This will set a dictionary containing Windows-specific launch parameters.
setWordSeparator(String) - Method in class org.apache.pdfbox.text.PDFTextStripper
Set the desired word separator for output text.
SetWordSpacing - Class in org.apache.pdfbox.contentstream.operator.text
Tw: Set word spacing.
SetWordSpacing(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.SetWordSpacing
 
setWordSpacing(float) - Method in class org.apache.pdfbox.pdmodel.graphics.state.PDTextState
Set the value of the wordSpacing.
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
Sets 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(PDXFAResource) - 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.
setXRef(COSObjectKey, long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
Populate XRef HashMap of current XRef object.
setXStep(float) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will set the XStep value.
setY(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Sets the y value of the tristimulus.
setYStep(float) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
This will set the YStep value.
setZ(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
Sets 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
 
shading - Variable in class org.apache.pdfbox.pdmodel.graphics.shading.ShadingPaint
 
SHADING_FILL - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SHADING_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
SHADING_TYPE1 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 1 = function based shading.
SHADING_TYPE2 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 2 = axial shading.
SHADING_TYPE3 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 3 = radial shading.
SHADING_TYPE4 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 4 = Free-Form Gouraud-Shaded Triangle Meshes.
SHADING_TYPE5 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 5 = Lattice-Form Gouraud-Shaded Triangle Meshes.
SHADING_TYPE6 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 6 = Coons Patch Meshes.
SHADING_TYPE7 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
shading type 7 = Tensor-Product Patch Meshes.
ShadingContext - Class in org.apache.pdfbox.pdmodel.graphics.shading
A base class to handle what is common to all shading types.
ShadingContext(PDShading, ColorModel, AffineTransform, Matrix) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.ShadingContext
Constructor.
ShadingFill - Class in org.apache.pdfbox.contentstream.operator.graphics
sh Fills the clipping area with the given shading pattern.
ShadingFill(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.ShadingFill
 
shadingFill(COSName) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Fill with Shading.
shadingFill(COSName) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
ShadingPaint<T extends PDShading> - Class in org.apache.pdfbox.pdmodel.graphics.shading
This is base class for all PDShading-Paints to allow other low level libraries access to the shading source data.
SHORT_STYLES - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAbstractAppearanceHandler
Line ending styles where the line has to be drawn shorter (minus line width).
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.PDActionURI
This will specify whether to track the mouse position when the URI is resolved.
SHOW_TEXT - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SHOW_TEXT_ADJUSTED - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SHOW_TEXT_LINE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
SHOW_TEXT_LINE_AND_SPACE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
showAnnotation(PDAnnotation) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Shows the given annotation.
showAnnotation(PDAnnotation) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
showFontGlyph(Matrix, PDFont, int, Vector) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a glyph is to be processed.
showFontGlyph(Matrix, PDFont, int, Vector) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
showForm(PDFormXObject) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Shows a form from the content stream.
showForm(PDFormXObject) - Method in class org.apache.pdfbox.rendering.PageDrawer
Shows a form from the content stream.
showGlyph(Matrix, PDFont, int, Vector) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a glyph is to be processed.
ShowText - Class in org.apache.pdfbox.contentstream.operator.text
Tj: Show text.
ShowText(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.ShowText
 
showText(byte[]) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Process text from the PDF Stream.
ShowTextAdjusted - Class in org.apache.pdfbox.contentstream.operator.text
TJ: Show text, with position adjustments.
ShowTextAdjusted(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.ShowTextAdjusted
 
ShowTextLine - Class in org.apache.pdfbox.contentstream.operator.text
': Move to the next line and show text.
ShowTextLine(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.ShowTextLine
 
ShowTextLineAndSpace - Class in org.apache.pdfbox.contentstream.operator.text
": Set word and character spacing, move to next line, and show text.
ShowTextLineAndSpace(PDFStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.text.ShowTextLineAndSpace
 
showTextString(byte[]) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a string of text is to be shown.
showTextStrings(COSArray) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a string of text with spacing adjustments is to be shown.
showTransparencyGroup(PDTransparencyGroup) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Shows a transparency group from the content stream.
showTransparencyGroup(PDTransparencyGroup) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
showTransparencyGroupOnGraphics(PDTransparencyGroup, Graphics2D) - Method in class org.apache.pdfbox.rendering.PageDrawer
For advanced users, to extract the transparency group into a separate graphics device.
showType3Glyph(Matrix, PDType3Font, int, Vector) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when a glyph is to be processed.
showType3Glyph(Matrix, PDType3Font, int, Vector) - Method in class org.apache.pdfbox.rendering.PageDrawer
 
SIG - Static variable in class org.apache.pdfbox.cos.COSName
 
SIG_FLAGS - Static variable in class org.apache.pdfbox.cos.COSName
 
SIG_REF - Static variable in class org.apache.pdfbox.cos.COSName
 
sign(InputStream) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface
Creates a cms signature for the given content
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
Set the image for the signature.
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
Creates the default signature options.
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
SigningSupport - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
Class to be used when creating PDF signatures externally.
SigningSupport(COSWriter) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SigningSupport
 
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
 
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.
SIZE - Static variable in class org.apache.pdfbox.util.Matrix
 
size() - Method in class org.apache.pdfbox.util.SmallMap
 
skipSpaces() - Method in class org.apache.pdfbox.pdfparser.BaseParser
This will skip all spaces and comments that are present.
skipWhiteSpaces() - Method in class org.apache.pdfbox.pdfparser.BaseParser
 
SM - Static variable in class org.apache.pdfbox.cos.COSName
 
SmallMap<K,V> - Class in org.apache.pdfbox.util
Map implementation with a smallest possible memory usage.
SmallMap() - Constructor for class org.apache.pdfbox.util.SmallMap
Creates empty map.
SmallMap(Map<? extends K, ? extends V>) - Constructor for class org.apache.pdfbox.util.SmallMap
Creates map filled with entries from provided map.
SMASK - Static variable in class org.apache.pdfbox.cos.COSName
 
SMASK_IN_DATA - Static variable in class org.apache.pdfbox.cos.COSName
 
SOFT_LIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
SOFT_LIGHT - Static variable in class org.apache.pdfbox.pdmodel.graphics.blend.BlendMode
 
SORT - Static variable in class org.apache.pdfbox.cos.COSName
 
sort(List<T>, Comparator<? super T>) - Static method in class org.apache.pdfbox.util.IterativeMergeSort
Sorts this list according to the order induced by the specified Comparator.
SOUND - Static variable in class org.apache.pdfbox.cos.COSName
 
source - Variable in class org.apache.pdfbox.pdfparser.BaseParser
This is the stream that will be read from.
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 - Static variable in class org.apache.pdfbox.cos.COSName
 
split(PDDocument) - Method in class org.apache.pdfbox.multipdf.Splitter
This will take a document and split into several other documents.
splitAtPage(int) - Method in class org.apache.pdfbox.multipdf.Splitter
Check if it is necessary to create a new document.
splitOnSpace(String) - Static method in class org.apache.pdfbox.util.StringUtil
 
Splitter - Class in org.apache.pdfbox.multipdf
Split a document into several other documents.
Splitter() - Constructor for class org.apache.pdfbox.multipdf.Splitter
 
SS - Static variable in class org.apache.pdfbox.cos.COSName
 
ST - Static variable in class org.apache.pdfbox.cos.COSName
 
Standard14Fonts - Class in org.apache.pdfbox.pdmodel.font
The "Standard 14" PDF fonts, also known as the "base 14" fonts.
Standard14Fonts.FontName - Enum in org.apache.pdfbox.pdmodel.font
Enum for the names of the 14 standard fonts.
STANDARD_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
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.pdmodel.font.encoding
This is an interface to a text encoder.
StandardProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
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 standard security handler.
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() - Method in class org.apache.pdfbox.text.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.text.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.text.PDFTextStripper
This method is available for subclasses of this class.
startPage(PDPage) - Method in class org.apache.pdfbox.text.PDFTextStripper
Start a new page.
STARTXREF - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The start xref token.
STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
STATE_MODEL - Static variable in class org.apache.pdfbox.cos.COSName
 
STATUS - Static variable in class org.apache.pdfbox.cos.COSName
 
STD_CF - Static variable in class org.apache.pdfbox.cos.COSName
 
STEM_H - Static variable in class org.apache.pdfbox.cos.COSName
 
STEM_V - Static variable in class org.apache.pdfbox.cos.COSName
 
STM_F - Static variable in class org.apache.pdfbox.cos.COSName
 
STR_F - Static variable in class org.apache.pdfbox.cos.COSName
 
STREAM - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The open stream token.
STREAM_STRING - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
This is a string constant that will be used for comparisons.
StringUtil - Class in org.apache.pdfbox.util
 
StringUtil() - Constructor for class org.apache.pdfbox.util.StringUtil
 
stringValue() - Method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingIntent
Returns the string value, as used in a PDF file.
stringValue() - Method in enum org.apache.pdfbox.pdmodel.PageLayout
Returns the string value, as used in a PDF file.
stringValue() - Method in enum org.apache.pdfbox.pdmodel.PageMode
Returns the string value, as used in a PDF file.
STROKE_PATH - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
StrokePath - Class in org.apache.pdfbox.contentstream.operator.graphics
S Stroke the path.
StrokePath(PDFGraphicsStreamEngine) - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.StrokePath
 
strokePath() - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
Stroke the path.
strokePath() - Method in class org.apache.pdfbox.rendering.PageDrawer
 
STROKING_COLOR - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STROKING_COLOR_CMYK - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STROKING_COLOR_GRAY - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STROKING_COLOR_N - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STROKING_COLOR_RGB - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STROKING_COLORSPACE - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
STRUCT_ELEM - Static variable in class org.apache.pdfbox.cos.COSName
 
STRUCT_PARENT - Static variable in class org.apache.pdfbox.cos.COSName
 
STRUCT_PARENTS - Static variable in class org.apache.pdfbox.cos.COSName
 
STRUCT_TREE_ROOT - Static variable in class org.apache.pdfbox.cos.COSName
 
STYLE - Static variable in class org.apache.pdfbox.cos.COSName
 
style(AppearanceStyle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
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_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
 
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionEmbeddedGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionHide
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionImportData
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionJavaScript
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionNamed
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionResetForm
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSound
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionSubmitForm
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionThread
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.PDActionURI
This type of action this object represents.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCaret
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle
The type of annotation.
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.PDAnnotationFreeText
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationInk
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.PDAnnotationPolygon
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPolyline
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.PDAnnotationSound
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquare
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
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.PDAnnotationUnderline
The type of annotation.
SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
The type of annotation.
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
 
SUBJECT - Static variable in class org.apache.pdfbox.cos.COSName
 
SUBJECT_DN - Static variable in class org.apache.pdfbox.cos.COSName
 
subList(int, int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
subset() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Replaces this font with a subset containing only the given Unicode characters.
subset() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
subset() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
SUBTYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
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.FDFAnnotationLink
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
 
SV - Static variable in class org.apache.pdfbox.cos.COSName
 
SV_CERT - Static variable in class org.apache.pdfbox.cos.COSName
 
SW - Static variable in class org.apache.pdfbox.cos.COSName
 
SY - Static variable in class org.apache.pdfbox.cos.COSName
 
SymbolEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This is an interface to a text encoder.
SYNCHRONOUS - Static variable in class org.apache.pdfbox.cos.COSName
 
SYSPROP_DEFLATELEVEL - Static variable in class org.apache.pdfbox.filter.Filter
Compression Level System Property.
SYSPROP_EOFLOOKUPRANGE - Static variable in class org.apache.pdfbox.pdfparser.COSParser
The range within the %%EOF marker will be searched.

T

T - Static variable in class org.apache.pdfbox.cos.COSName
 
T - Static variable in class org.apache.pdfbox.pdfparser.BaseParser
 
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
TABLOID - Static variable in class org.apache.pdfbox.pdmodel.common.PDRectangle
An immutable rectangle the size of U.S.
TARGET - Static variable in class org.apache.pdfbox.cos.COSName
 
TD - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TD
TEMPLATES - Static variable in class org.apache.pdfbox.cos.COSName
 
text(PlainText) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
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
textAlign(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
textAlign(PlainTextFormatter.TextAlign) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
TextPosition - Class in org.apache.pdfbox.text
This represents a string and a position on the screen of those characters.
TextPosition(int, float, float, Matrix, float, float, float, float, float, String, int[], PDFont, float, int) - Constructor for class org.apache.pdfbox.text.TextPosition
Constructor.
TextPositionComparator - Class in org.apache.pdfbox.text
This class is a comparator for TextPosition operators.
TextPositionComparator() - Constructor for class org.apache.pdfbox.text.TextPositionComparator
 
TH - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TH
THREAD - Static variable in class org.apache.pdfbox.cos.COSName
 
THREADS - Static variable in class org.apache.pdfbox.cos.COSName
 
THREE - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number three.
THREE_DD - Static variable in class org.apache.pdfbox.cos.COSName
 
THUMB - Static variable in class org.apache.pdfbox.cos.COSName
 
TI - Static variable in class org.apache.pdfbox.cos.COSName
 
TILING_CONSTANT_SPACING - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
tiling type 1 = constant spacing.
TILING_CONSTANT_SPACING_FASTER_TILING - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
tiling type 3 = constant spacing and faster tiling.
TILING_NO_DISTORTION - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPattern
tiling type 2 = no distortion.
TILING_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
TIME_STAMP - Static variable in class org.apache.pdfbox.cos.COSName
 
tintTransform(float[], int[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
TITLE - Static variable in class org.apache.pdfbox.cos.COSName
 
TK - Static variable in class org.apache.pdfbox.cos.COSName
 
TM - Static variable in class org.apache.pdfbox.cos.COSName
 
TO_UNICODE - Static variable in class org.apache.pdfbox.cos.COSName
 
toArray() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
toArray(X[]) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
toByteArray() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
This will copy the stream into a byte array.
toByteArray() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.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
Returns the Calendar for a given COS string containing a date, or null if it cannot be parsed.
toCalendar(String) - Static method in class org.apache.pdfbox.util.DateConverter
Returns the Calendar for a given string containing a date, or null if it cannot be parsed.
TOCI - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TOCI
toCOSArray() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns the color component values as a COS array
toCOSArray() - Method in class org.apache.pdfbox.util.Matrix
Returns a COS array which represent the geometric relevant components of the matrix.
toCOSNameStringList() - Method in class org.apache.pdfbox.cos.COSArray
This will return a list of names if the COSArray consists of COSNames only.
toCOSNumberFloatList() - Method in class org.apache.pdfbox.cos.COSArray
This will return a list of float values if the COSArray consists of COSNumbers only.
toCOSNumberIntegerList() - Method in class org.apache.pdfbox.cos.COSArray
This will return a list of int values if the COSArray consists of COSNumbers only.
toCOSStringStringList() - Method in class org.apache.pdfbox.cos.COSArray
This will return a list of names if the COSArray consists of COSStrings only.
toDebugString() - Method in class org.apache.pdfbox.pdmodel.font.FontProvider
Returns a string containing debugging information.
toFloatArray() - Method in class org.apache.pdfbox.cos.COSArray
This will take an COSArray of numbers and convert it to a float[].
toGeneralPath() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
Returns a general path equivalent to this rectangle.
toHexString() - 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.
toIncrement() - Method in interface org.apache.pdfbox.cos.COSUpdateInfo
Uses this COSUpdateInfo as the base object of a new COSIncrement.
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.
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShading
Returns an AWT paint which corresponds to this shading
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
 
toPaint(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEBasedColorSpace
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the image in this colorspace or null.
toRawImage(WritableRaster, ColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the given raster as BufferedImage with the given awtColorSpace using a ComponentColorModel.
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
toRawImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
 
toRGB() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
Returns the packed RGB value for this color, if any.
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the RGB equivalent of the given color value.
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
toRGB(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEBasedColorSpace
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the (A)RGB equivalent of the given raster.
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDJPXColorSpace
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
toRGBImage(WritableRaster) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
toRGBImageAWT(WritableRaster, ColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
Returns the (A)RGB equivalent of the given raster, using the given AWT color space to perform the conversion.
toRGBImageAWT(WritableRaster, ColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
 
toString() - Method in class org.apache.pdfbox.contentstream.operator.Operator
This will print a string rep of this class.
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.COSNull
toString() - Method in class org.apache.pdfbox.cos.COSObject
toString() - Method in class org.apache.pdfbox.cos.COSObjectKey
 
toString() - Method in class org.apache.pdfbox.cos.COSString
 
toString() - Method in class org.apache.pdfbox.pdfparser.xref.FreeXReference
Returns a string representation of this crossreference stream entry.
toString() - Method in class org.apache.pdfbox.pdfparser.xref.NormalXReference
Returns a string representation of this crossreference stream entry.
toString() - Method in class org.apache.pdfbox.pdfparser.xref.ObjectStreamXReference
Returns a string representation of this crossreference stream entry.
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.function.PDFunction
toString() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
toString() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionTypeIdentity
toString() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
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.PDParentTreeValue
 
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.font.CIDSystemInfo
 
toString() - Method in class org.apache.pdfbox.pdmodel.font.FontInfo
 
toString() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDSystemInfo
 
toString() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
 
toString() - Method in class org.apache.pdfbox.pdmodel.font.PDPanoseClassification
 
toString() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
toString() - Method in enum org.apache.pdfbox.pdmodel.font.Standard14Fonts.FontName
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEBasedColorSpace
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColor
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceColorSpace
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNProcess
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
 
toString() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
 
toString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
 
toString() - Method in class org.apache.pdfbox.text.TextPosition
Show the string data for this text position.
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
 
toString() - Method in class org.apache.pdfbox.util.Vector
 
toTextString() - Method in class org.apache.pdfbox.cos.COSStream
Returns the contents of the stream as a PDF "text string".
toUnicode(String) - Method in class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Returns the Unicode character sequence for the given glyph name, or null if there isn't any.
toUnicode(int, GlyphList) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the Unicode character sequence which corresponds to the given character code.
toUnicode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns the Unicode character sequence which corresponds to the given character code.
toUnicode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
toUnicode(int, GlyphList) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
toUnicode(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
TR - Static variable in class org.apache.pdfbox.cos.COSName
 
TR - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
TR
TR2 - Static variable in class org.apache.pdfbox.cos.COSName
 
TRAILER - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The trailer token.
TRANS - Static variable in class org.apache.pdfbox.cos.COSName
 
transferClip(Graphics2D) - Method in class org.apache.pdfbox.rendering.PageDrawer
Transfer clip to the destination device.
transform(Matrix) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
Returns a path which represents this rectangle having been transformed by the given matrix.
transform(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
transform(Point2D) - Method in class org.apache.pdfbox.util.Matrix
Transforms the given point by this matrix.
transform(Vector) - Method in class org.apache.pdfbox.util.Matrix
Transforms the given vector by this matrix.
TRANSFORM_METHOD - Static variable in class org.apache.pdfbox.cos.COSName
 
TRANSFORM_PARAMS - Static variable in class org.apache.pdfbox.cos.COSName
 
transformedPoint(float, float) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Transforms a point using the CTM.
transformPoint(float, float) - Method in class org.apache.pdfbox.util.Matrix
Transforms the given point by this matrix.
transformWidth(float) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Transforms a width using the CTM.
translate(Vector) - Method in class org.apache.pdfbox.util.Matrix
Translates this matrix by the given vector.
translate(float, float) - Method in class org.apache.pdfbox.util.Matrix
Translates this matrix by the given amount.
TRANSPARENCY - Static variable in class org.apache.pdfbox.cos.COSName
 
TRAPPED - Static variable in class org.apache.pdfbox.cos.COSName
 
TREF - Static variable in class org.apache.pdfbox.cos.COSName
 
TRIM_BOX - Static variable in class org.apache.pdfbox.cos.COSName
 
TRUE - Static variable in class org.apache.pdfbox.cos.COSBoolean
The PDF true value.
TRUE_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
TRUSTED_MODE - Static variable in class org.apache.pdfbox.cos.COSName
 
TU - Static variable in class org.apache.pdfbox.cos.COSName
 
TWO - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number two.
TX - Static variable in class org.apache.pdfbox.cos.COSName
Acro form field type for text field.
TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
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.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 object.
TYPE0 - Static variable in class org.apache.pdfbox.cos.COSName
 
TYPE1 - Static variable in class org.apache.pdfbox.cos.COSName
 
Type1Encoding - Class in org.apache.pdfbox.pdmodel.font.encoding
An encoding for a Type 1 font.
Type1Encoding() - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
Creates an empty encoding.
Type1Encoding(FontMetrics) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
Creates an encoding from the given AFM font metrics.
TYPE3 - Static variable in class org.apache.pdfbox.cos.COSName
 
TYPE3_D0 - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
TYPE3_D1 - Static variable in class org.apache.pdfbox.contentstream.operator.OperatorName
 
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.
TYPE_SHADING_PATTERN - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Shading pattern type.
TYPE_TILING_PATTERN - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Tiling pattern type.
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
 
UE - Static variable in class org.apache.pdfbox.cos.COSName
 
UF - Static variable in class org.apache.pdfbox.cos.COSName
 
UNCHANGED - Static variable in class org.apache.pdfbox.cos.COSName
 
unCheck() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
Unchecks the check box.
UNIX - Static variable in class org.apache.pdfbox.cos.COSName
 
UNSPECIFIED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
An "unspecified" default float value.
unsupportedOperator(Operator, List<COSBase>) - Method in class org.apache.pdfbox.contentstream.PDFStreamEngine
Called when an unsupported operator is encountered.
URI - Static variable in class org.apache.pdfbox.cos.COSName
 
URL - Static variable in class org.apache.pdfbox.cos.COSName
 
URL_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
USAGE - Static variable in class org.apache.pdfbox.cos.COSName
 
USE_CMAP - Static variable in class org.apache.pdfbox.cos.COSName
 
USER_UNIT - Static variable in class org.apache.pdfbox.cos.COSName
 
userPropertyChanged(PDUserProperty) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
Notify a possible change of user properties.
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
 
validate(PDActionJavaScript, String) - Method in interface org.apache.pdfbox.pdmodel.interactive.form.ScriptingHandler
Handle the fields validate event action.
valueOf(String) - Static method in enum org.apache.pdfbox.multipdf.Overlay.Position
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.multipdf.PDFMergerUtility.AcroFormMergeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.multipdf.PDFMergerUtility.DocumentMergeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdfparser.xref.XReferenceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdfparser.XrefTrailerResolver.XRefType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.font.FontFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.font.Standard14Fonts.FontName
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup.RenderState
Returns the enum constant of this type with the specified name.
valueOf(COSName) - Static method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup.RenderState
Returns the base state represented by the given COSName.
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.graphics.state.RenderingIntent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.graphics.state.RenderingMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.action.OpenMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionDimension
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionMotion
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDTransitionStyle
Returns the enum constant of this type with the specified name.
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.pdmodel.PageLayout
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.PageMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.printing.Orientation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.printing.Scaling
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.rendering.ImageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.rendering.RenderDestination
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.pdfbox.util.filetypedetector.FileType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.pdfbox.multipdf.Overlay.Position
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.multipdf.PDFMergerUtility.AcroFormMergeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.multipdf.PDFMergerUtility.DocumentMergeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdfparser.xref.XReferenceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.pdfparser.XrefTrailerResolver.XRefType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
values() - Static method in enum org.apache.pdfbox.pdmodel.font.FontFormat
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.font.Standard14Fonts.FontName
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.graphics.optionalcontent.PDOptionalContentGroup.RenderState
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.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.graphics.state.RenderingIntent
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.graphics.state.RenderingMode
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.action.OpenMode
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.pagenavigation.PDTransitionDimension
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.pagenavigation.PDTransitionDirection
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.pagenavigation.PDTransitionMotion
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.pagenavigation.PDTransitionStyle
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.pdmodel.PageLayout
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.PageMode
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.PDPageContentStream.AppendMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.printing.Orientation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.printing.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.rendering.ImageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.pdfbox.rendering.RenderDestination
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.filetypedetector.FileType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class org.apache.pdfbox.util.SmallMap
Returns a collection of the values contained in this map.
VE - Static variable in class org.apache.pdfbox.cos.COSName
 
Vector - Class in org.apache.pdfbox.util
A 2D vector.
Vector(float, float) - Constructor for class org.apache.pdfbox.util.Vector
 
VERISIGN_PPKVS - Static variable in class org.apache.pdfbox.cos.COSName
 
VERSION - Static variable in class org.apache.pdfbox.cos.COSName
 
VERSION - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The output version of the PDF.
Version - Class in org.apache.pdfbox.util
Exposes PDFBox version.
VERSION0_UNDOCUMENTED_UNSUPPORTED - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
See PDF Reference 1.4 Table 3.13.
VERSION1_40_BIT_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
See PDF Reference 1.4 Table 3.13.
VERSION2_VARIABLE_LENGTH_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
See PDF Reference 1.4 Table 3.13.
VERSION3_UNPUBLISHED_ALGORITHM - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
See PDF Reference 1.4 Table 3.13.
VERSION4_SECURITY_HANDLER - Static variable in class org.apache.pdfbox.pdmodel.encryption.PDEncryption
See PDF Reference 1.4 Table 3.13.
VERTICES - Static variable in class org.apache.pdfbox.cos.COSName
 
VERTICES_PER_ROW - Static variable in class org.apache.pdfbox.cos.COSName
 
VIEW - Static variable in class org.apache.pdfbox.cos.COSName
 
VIEW_AREA - Static variable in class org.apache.pdfbox.cos.COSName
 
VIEW_CLIP - Static variable in class org.apache.pdfbox.cos.COSName
 
VIEW_STATE - Static variable in class org.apache.pdfbox.cos.COSName
 
VIEWER_PREFERENCES - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
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
 
visualSignEnabled(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
sets visible signature to be added or not
VOLUME - Static variable in class org.apache.pdfbox.cos.COSName
 
VP - Static variable in class org.apache.pdfbox.cos.COSName
 
VRI - Static variable in class org.apache.pdfbox.cos.COSName
 

W

W - Static variable in class org.apache.pdfbox.cos.COSName
 
W2 - Static variable in class org.apache.pdfbox.cos.COSName
 
WARICHU - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
Warichu
WC - Static variable in class org.apache.pdfbox.cos.COSName
 
WHITE_POINT - Static variable in class org.apache.pdfbox.cos.COSName
 
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.
WIDGET - Static variable in class org.apache.pdfbox.cos.COSName
 
WIDTH - Static variable in class org.apache.pdfbox.cos.COSName
 
width(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
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
 
willBeSubset() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
Returns true if this font will be subset when embedded.
willBeSubset() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
 
willBeSubset() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
 
WIN - Static variable in class org.apache.pdfbox.cos.COSName
 
WIN_ANSI_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
 
WinAnsiEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This the win ansi encoding.
WMODE - Static variable in class org.apache.pdfbox.cos.COSName
 
WP - Static variable in class org.apache.pdfbox.cos.COSName
 
WP - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
WP
wpX - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
wpY - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
wpZ - Variable in class org.apache.pdfbox.pdmodel.graphics.color.PDCIEDictionaryBasedColorSpace
 
wrapInSaveRestore(PDPage) - Method in class org.apache.pdfbox.multipdf.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.
wrapLines(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.layout.PlainTextFormatter.Builder
 
write(byte[]) - Method in class org.apache.pdfbox.cos.COSOutputStream
 
write(byte[], int, int) - Method in class org.apache.pdfbox.cos.COSOutputStream
 
write(int) - Method in class org.apache.pdfbox.cos.COSOutputStream
 
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(PDDocument, SignatureInterface) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the pdf document.
write(FDFDocument) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
This will write the fdf document.
writeCharacters(TextPosition) - Method in class org.apache.pdfbox.text.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.
writeEOL() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write an EOL to the stream.
writeExternalSignature(byte[]) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
Write externally created signature of PDF data obtained via COSWriter.getDataToSign() method.
writeHexByte(byte, OutputStream) - Static method in class org.apache.pdfbox.util.Hex
Writes the given byte as hex value to the given output stream.
writeHexBytes(byte[], OutputStream) - Static method in class org.apache.pdfbox.util.Hex
Writes the given byte array as hex value to the given output stream.
writeLF() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
This will write a Linefeed to the stream.
writeLineSeparator() - Method in class org.apache.pdfbox.text.PDFTextStripper
Write the line separator value to the output stream.
writeObjectsToStream(COSStream) - Method in class org.apache.pdfbox.pdfwriter.compress.COSWriterObjectStream
Writes all prepared COSObjects to the given COSStream.
writePage() - Method in class org.apache.pdfbox.text.PDFTextStripper
This will print the text of the processed page to "output".
writePage() - Method in class org.apache.pdfbox.text.PDFTextStripperByArea
This will print the processed page text to the output stream.
writePageEnd() - Method in class org.apache.pdfbox.text.PDFTextStripper
Write something (if defined) at the end of a page.
writePageStart() - Method in class org.apache.pdfbox.text.PDFTextStripper
Write something (if defined) at the start of a page.
writeParagraphEnd() - Method in class org.apache.pdfbox.text.PDFTextStripper
Write something (if defined) at the end of a paragraph.
writeParagraphSeparator() - Method in class org.apache.pdfbox.text.PDFTextStripper
writes the paragraph separator string to the output.
writeParagraphStart() - Method in class org.apache.pdfbox.text.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.
writeReference(COSBase) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
visitFromObjRef method comment.
writeString(COSString, OutputStream) - Static method in class org.apache.pdfbox.pdfwriter.COSWriter
This will output the given byte getString as a PDF object.
writeString(byte[], OutputStream) - Static method in class org.apache.pdfbox.pdfwriter.COSWriter
This will output the given text/byte getString as a PDF object.
writeString(String, List<TextPosition>) - Method in class org.apache.pdfbox.text.PDFTextStripper
Write a Java string to the output stream.
writeString(String) - Method in class org.apache.pdfbox.text.PDFTextStripper
Write a Java string to the output stream.
writeText(PDDocument, Writer) - Method in class org.apache.pdfbox.text.PDFTextStripper
This will take a PDDocument and write the text of that document to the print writer.
writeToken(COSBase) - Method in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
Writes a single operand token.
writeToken(Operator) - Method in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
Writes a single operator token.
writeTokens(Object...) - Method in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
Writes a series of tokens followed by a new line.
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.text.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.
WS - Static variable in class org.apache.pdfbox.cos.COSName
 
WT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
WT

X

X - Static variable in class org.apache.pdfbox.cos.COSName
 
X_STEP - Static variable in class org.apache.pdfbox.cos.COSName
 
xAxis(float) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
 
XFA - Static variable in class org.apache.pdfbox.cos.COSName
 
xfaIsDynamic() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
This will tell if the AcroForm is a dynamic XFA form.
XHEIGHT - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
xobject(PDXObject) - Method in class org.apache.pdfbox.text.PDFMarkedContentExtractor
 
XREF - Static variable in class org.apache.pdfbox.cos.COSName
 
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
 
XREF_USED - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
The xref used token.
XReferenceEntry - Interface in org.apache.pdfbox.pdfparser.xref
An implementing class represents an entry, as it can be found in a PDF's crossreference stream (PDFXRefStream).
XReferenceType - Enum in org.apache.pdfbox.pdfparser.xref
An instance of this class represents a type for a XReferenceEntry, as it can be found in a PDF's PDFXRefStream.
xrefTrailerResolver - Variable in class org.apache.pdfbox.pdfparser.COSParser
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
 
XrefTrailerResolver.XRefType - Enum in org.apache.pdfbox.pdfparser
The XRefType of a trailer.

Y

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

Z

ZA_DB - Static variable in class org.apache.pdfbox.cos.COSName
 
ZapfDingbatsEncoding - Class in org.apache.pdfbox.pdmodel.font.encoding
This is an interface to a text encoder.
ZERO - Static variable in class org.apache.pdfbox.cos.COSFloat
 
ZERO - Static variable in class org.apache.pdfbox.cos.COSInteger
Constant for the number zero.
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 
Skip navigation links

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