Return-Path: X-Original-To: apmail-pdfbox-commits-archive@www.apache.org Delivered-To: apmail-pdfbox-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CFC1218382 for ; Wed, 2 Mar 2016 10:24:47 +0000 (UTC) Received: (qmail 28467 invoked by uid 500); 2 Mar 2016 10:24:22 -0000 Delivered-To: apmail-pdfbox-commits-archive@pdfbox.apache.org Received: (qmail 27192 invoked by uid 500); 2 Mar 2016 10:24:21 -0000 Mailing-List: contact commits-help@pdfbox.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pdfbox.apache.org Delivered-To: mailing list commits@pdfbox.apache.org Received: (qmail 25813 invoked by uid 99); 2 Mar 2016 10:16:06 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Mar 2016 10:16:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 8BFD1E78D9; Wed, 2 Mar 2016 10:15:59 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: msahyoun@apache.org To: commits@pdfbox.apache.org Date: Wed, 02 Mar 2016 10:16:32 -0000 Message-Id: In-Reply-To: <9b1cc2a6aea246329dc4bcf9091a85e6@git.apache.org> References: <9b1cc2a6aea246329dc4bcf9091a85e6@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [35/37] pdfbox-docs git commit: PDFBOX-3030: update javadocs http://git-wip-us.apache.org/repos/asf/pdfbox-docs/blob/093b2e4c/content/docs/2.0.0-SNAPSHOT/javadocs/index-all.html ---------------------------------------------------------------------- diff --git a/content/docs/2.0.0-SNAPSHOT/javadocs/index-all.html b/content/docs/2.0.0-SNAPSHOT/javadocs/index-all.html index 8764b3c..6f9830a 100644 --- a/content/docs/2.0.0-SNAPSHOT/javadocs/index-all.html +++ b/content/docs/2.0.0-SNAPSHOT/javadocs/index-all.html @@ -444,6 +444,8 @@
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
 
affineTransformParams(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
@@ -829,6 +831,8 @@
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.
@@ -1037,10 +1041,14 @@
Utility class providing common Charsets used in PDFBox.
-
check() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
+
check() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
Checks the check box.
+
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
@@ -1070,12 +1078,16 @@
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.
+
CL - 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.
@@ -1191,6 +1203,16 @@
Close the content stream.
+
closeAndFillAndStroke() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
+
+
Close, fill, and then stroke the path, using the nonzero winding number rule to determine the + region to fill.
+
+
closeAndFillAndStrokeEvenOdd() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
+
+
Close, fill, and then stroke the path, using the even-odd rule to determine the region to + fill.
+
closeAndStroke() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Close and stroke the path.
@@ -1703,6 +1725,12 @@
COSWriter(OutputStream, InputStream) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
+ +
+
COSWriter(OutputStream, RandomAccessRead) - Constructor for class org.apache.pdfbox.pdfwriter.COSWriter
+
COSWriter constructor for incremental updates.
COSWriterXRefEntry - Class in org.apache.pdfbox.pdfwriter
@@ -1758,6 +1786,10 @@
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(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDAbstractPattern
Create the correct PD Model pattern based on the COS base pattern.
@@ -1867,26 +1899,28 @@
Creates a new PDFont instance with the appropriate subclass.
-
createFormaterRectangle(byte[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
+
createFormatterRectangle(byte[]) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
-
createFormaterRectangle(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
+
createFormatterRectangle(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
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 page of - a TIFF file.
+
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 the first page of - a TIFF file.
+
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.createFromFile(File, PDDocument) for +
Create a PDImageXObject from an image file, see PDImageXObject.createFromFileByExtension(File, PDDocument) for more details.
-
createFromFile(File, PDDocument) - Static method in class org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject
+
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.
@@ -2076,7 +2110,7 @@
 
createSignatureRectangle(PDSignatureField, PDVisibleSignDesigner) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
-
Creates SingatureRectangle.
+
Creates SignatureRectangle.
createSignatureRectangle(PDSignatureField, PDVisibleSignDesigner) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
 
@@ -2263,6 +2297,8 @@
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.
@@ -2290,6 +2326,10 @@
 
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.
+
DEVICECMYK - Static variable in class org.apache.pdfbox.cos.COSName
 
DEVICEGRAY - Static variable in class org.apache.pdfbox.cos.COSName
@@ -2484,6 +2524,12 @@
DrawObject() - Constructor for class org.apache.pdfbox.contentstream.operator.graphics.DrawObject
 
+
DrawObject - Class in org.apache.pdfbox.contentstream.operator.markedcontent
+
+
Do: Draws an XObject.
+
+
DrawObject() - Constructor for class org.apache.pdfbox.contentstream.operator.markedcontent.DrawObject
+
 
drawPage(Graphics, PDRectangle) - Method in class org.apache.pdfbox.rendering.PageDrawer
Draws the page to the requested context.
@@ -3354,6 +3400,10 @@
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(int) - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
Deprecated. @@ -3362,7 +3412,17 @@
fill() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
-
Fills the path using the nonzero winding rule.
+
Fills the path using the nonzero winding number rule.
+
+
fillAndStroke() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
+
+
Fill and then stroke the path, using the nonzero winding number rule to determine the region + to fill.
+
+
fillAndStrokeEvenOdd() - Method in class org.apache.pdfbox.pdmodel.PDPageContentStream
+
+
Fill and then stroke the path, using the even-odd rule to determine the region to + fill.
fillAndStrokePath(int) - Method in class org.apache.pdfbox.contentstream.PDFGraphicsStreamEngine
@@ -3549,6 +3609,10 @@
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.
@@ -3587,7 +3651,7 @@
 
FontCache - Class in org.apache.pdfbox.pdmodel.font
-
A cache for system fonts.
+
An in-memory cache for system fonts.
FontCache() - Constructor for class org.apache.pdfbox.pdmodel.font.FontCache
 
@@ -3613,6 +3677,8 @@
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.
@@ -3627,9 +3693,9 @@
Form
-
formaterRectangleParams(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
+
formatterRectangleParams(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
-
sets formatter PDRectangle;
+
Sets formatter PDRectangle
FORMTYPE - Static variable in class org.apache.pdfbox.cos.COSName
 
@@ -4170,6 +4236,10 @@
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).
@@ -4202,6 +4272,11 @@
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.PDAnnotationSquareCircle
@@ -4258,6 +4333,8 @@
Returns the raw bytes of the string.
+
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.
@@ -4284,6 +4361,10 @@
Returns the C1 values of the function, 1 if empty.
+
getCallout() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
+
+
This will get the coordinates of the the callout line.
+
getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the CapHeight for the font.
@@ -4430,7 +4511,7 @@
getCodeToNameMap() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
-
Returns an unmodifiable view of the Code2Name mapping.
+
Returns an unmodifiable view of the code -> name mapping.
getColor() - Method in class org.apache.pdfbox.contentstream.operator.color.SetColor
@@ -4534,6 +4615,10 @@
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.
@@ -4756,7 +4841,7 @@
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Convert this standard java object to a COS object.
+
Get the cos stream associated with this object.
getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
@@ -5064,7 +5149,9 @@
getCOSStream() - Method in class org.apache.pdfbox.pdmodel.graphics.PDXObject
-
Returns the stream.
+
Deprecated. + +
getCOSValue() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
@@ -5237,6 +5324,10 @@
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.form.PDAcroForm
Get the default appearance.
@@ -5285,6 +5376,10 @@
This will get the default resources for the acro form.
+
getDefaultStyle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
+
+
Get the default style string.
+
getDefaultStyleString() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
Get the default style string.
@@ -5616,6 +5711,22 @@
Returns the Encoding vector.
+
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.MacRomanEncoding
+
 
+
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.StandardEncoding
+
 
+
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.Type1Encoding
+
 
+
getEncodingName() - Method in class org.apache.pdfbox.pdmodel.font.encoding.WinAnsiEncoding
+
 
getEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
This will get the encryption dictionary for this document.
@@ -6037,7 +6148,7 @@
getFontBBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
-
This will get the fonts bounding box.
+
This will get the fonts bounding box from its dictionary.
getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
@@ -6157,16 +6268,16 @@
Returns the font's format.
-
getFormaterRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
-
-
Gets formatter rectangle
-
-
getFormaterRectangleParams() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner
-
 
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
+
+
getFormatterRectangleParams() - 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.
@@ -6187,6 +6298,10 @@
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.
@@ -6257,6 +6372,10 @@
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 Encoding vector.
@@ -6334,7 +6453,9 @@
 
getHeight(int) - Method in interface org.apache.pdfbox.pdmodel.font.PDFontLike
-
Returns the height of the given character, in glyph space.
+
Deprecated. +
Use #getBoundingBox().#getHeight(int) instead.
+
getHeight(int) - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
 
@@ -6529,7 +6650,7 @@
Gets inner form Resource
-
getInnterFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
+
getInnerFormStream() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
Gets Inner form Stream.
@@ -6539,8 +6660,8 @@
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.
+
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
@@ -6651,10 +6772,6 @@
 
getInterpolate() - Method in class org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage
 
-
getInvertedEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
-
Inverts the font's Encoding.
-
getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
This will get the italic angle for the font.
@@ -6875,6 +6992,10 @@
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.
+
getLineHeight() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
Gets the element’s preferred height in the block-progression direction @@ -7096,12 +7217,12 @@
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.
+
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.
+
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
@@ -7207,6 +7328,8 @@
 
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
@@ -7417,6 +7540,10 @@
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.
@@ -7646,7 +7773,7 @@
This will get the offset into the document.
-
getOnValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
+
getOnValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
Get the value which sets the check box to the On state.
@@ -7728,7 +7855,7 @@
 
getOS() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict
-
Indicates the operation system.
+
Indicates the operating system.
getOutput() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
@@ -7742,10 +7869,6 @@
 
getOutputConditionIdentifier() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent
 
-
getOutputFile() - Method in class org.apache.pdfbox.multipdf.Overlay
-
-
Returns the output file.
-
getOutputIntents() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
Get the list of OutputIntents defined in the document.
@@ -7817,7 +7940,7 @@
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Get the page number.
+
Get the 0-based page number.
getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
@@ -7894,7 +8017,9 @@
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.
@@ -8159,13 +8284,13 @@
Returns the PostScript name of the font.
-
getPreferedSignatureSize() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
+
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 our preferred size
+
Gets the preferred signature size in bytes.
getPrefix() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
@@ -8665,6 +8790,10 @@
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
@@ -8687,10 +8816,6 @@
getSignerName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
 
-
getSingatureRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure
-
-
Gets SignatureRectangle
-
getSize() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
Get the size of the embedded file.
@@ -8869,7 +8994,9 @@
getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the cos stream associated with this object.
+
Deprecated. + +
getStream() - Method in class org.apache.pdfbox.pdmodel.graphics.PDXObject
@@ -9294,6 +9421,18 @@
Gets the resolved trailer.
+
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.
@@ -9578,6 +9717,11 @@
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.
@@ -9937,7 +10081,7 @@
PostScript glyph list, maps glyph names to sequences of Unicode characters.
-
GlyphList(InputStream) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
+
GlyphList(InputStream, int) - Constructor for class org.apache.pdfbox.pdmodel.font.encoding.GlyphList
Creates a new GlyphList from a glyph list file.
@@ -10074,6 +10218,10 @@
 
hashCode() - Method in class org.apache.pdfbox.pdmodel.PDPage
 
+
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.PublicKeySecurityHandler
Returns whether a protection policy has been set.
@@ -10178,6 +10326,8 @@
 
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
 
IM - Static variable in class org.apache.pdfbox.cos.COSName
@@ -10311,9 +10461,9 @@
Insert a page before another page within a page tree.
-
insertInnerFormToHolerResources(PDFormXObject, PDResources) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
+
insertInnerFormToHolderResources(PDFormXObject, PDResources) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder
 
-
insertInnerFormToHolerResources(PDFormXObject, PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder
+
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
@@ -10414,6 +10564,8 @@
Indicates that an invalid password was supplied.
+
inverted - Variable in class org.apache.pdfbox.pdmodel.font.encoding.Encoding
+
 
IOUtils - Class in org.apache.pdfbox.io
This class contains various I/O-related methods.
@@ -10452,7 +10604,7 @@
This will tell if this acro form is caching the fields.
-
isChecked() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
+
isChecked() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
This will tell if this radio button is currently checked or not.
@@ -10680,6 +10832,10 @@
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.
@@ -10745,6 +10901,8 @@
Returns true if this is an NChannel (PDF 1.6) color space.
+
isNeedToBeUpdated() - Method in class org.apache.pdfbox.cos.COSArray
+
 
isNeedToBeUpdated() - Method in class org.apache.pdfbox.cos.COSDictionary
 
isNeedToBeUpdated() - Method in class org.apache.pdfbox.cos.COSObject
@@ -10802,6 +10960,8 @@
/** 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.
@@ -10821,6 +10981,8 @@
Returns true if this color value is a pattern.
+
isPrepend() - Method in enum org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode
+
 
isPrinted() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
Get the printed flag.
@@ -11073,7 +11235,7 @@
 
keyLength - Variable in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
The length of the secret key used to encrypt the document.
+
The length in bits of the secret key used to encrypt the document.
keySet() - Method in class org.apache.pdfbox.cos.COSDictionary
@@ -11345,6 +11507,10 @@
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.
+
load(File) - Static method in class org.apache.pdfbox.pdmodel.PDDocument
Parses a PDF.
@@ -12131,6 +12297,8 @@ structure types and attributes) into a PDF file.
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.
@@ -12918,11 +13086,11 @@ structure types and attributes) into a PDF file.
Creates a new CalRGB color space using the given COS array.
-
PDCheckbox - Class in org.apache.pdfbox.pdmodel.interactive.form
+
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
+
PDCheckBox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox
 
PDChoice - Class in org.apache.pdfbox.pdmodel.interactive.form
@@ -12951,6 +13119,10 @@ structure types and attributes) into a PDF file.
Constructor.
+
PDCIDFontType2(COSDictionary, PDType0Font, TrueTypeFont) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2
+
+
Constructor.
+