- GAMMA - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- GARBAGE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
-
Garbage bytes used to create the PDF header.
- generateXMLHighlight(PDDocument, String, Writer) - Method in class org.apache.pdfbox.util.PDFHighlighter
-
Generate an XML highlight string based on the PDF.
- generateXMLHighlight(PDDocument, String[], Writer) - Method in class org.apache.pdfbox.util.PDFHighlighter
-
Generate an XML highlight string based on the PDF.
- get(int) - Method in class org.apache.pdfbox.cos.COSArray
-
This will get an object from the array.
- get(long) - Static method in class org.apache.pdfbox.cos.COSInteger
-
Returns a COSInteger instance with the given value.
- get(String) - Static method in class org.apache.pdfbox.cos.COSNumber
-
This factory method will get the appropriate number object.
- get(int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
- get(Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
- get(int) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get a stream (or the reference to a stream) from the array.
- getAcroForm() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will get the acroform that this field is part of.
- getAcroForm() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
This will get the documents acroform.
- getAction() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the action that is associated with this field.
- getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
- getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Get the action to be performed when this annotation is to be activated.
- getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Get the action to be performed when this annotation is to be activated.
- getAction() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the action of this node.
- getActions() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Get the additional actions for this field.
- getActions() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Get the additional actions for this field.
- getActions() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
- getActions() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
Get the page actions.
- getActualText() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the actual text (ActualText).
- getActualText() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the actual text (ActualText).
- getAdditionalActions() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get a list of additional actions that will get executed based
on events.
- getAddMoreFormatting() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will tell if the text stripper should add some more text formatting.
- getAFM() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get an AFM object if one exists.
- getAfter() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This will get the javascript that is executed after the import.
- getAfterColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Gets the colour for the after edge.
- getAllKids(List) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will return all kids of this node as PDPage.
- getAllPages() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
The PDF document contains a hierarchical structure of PDPageNode and PDPages, which
is mostly just a way to store this information.
- getAlphaConstants() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the stroke alpha constants property.
- getAlphaSourceFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the alpha source flag.
- getAlternateCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the alternate caption.
- getAlternateColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will get the alternate color space for this separation.
- getAlternateColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will get the alternate color space for this separation.
- getAlternateColorSpaces() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will return a list of alternate color spaces(PDColorSpace) if the display application
does not support this icc stream.
- getAlternateDescription() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the alternate description (Alt).
- getAlternateDescription() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the alternate description (Alt).
- getAlternateFieldName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Gets the alternate name of the field.
- getAlternateIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the alternate icon.
- getAlternateName() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Gets the alternate name of the field (Desc).
- getAngles() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the angles.
- getAnnotationFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will get the flags for this field.
- getAnnotationName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will get the name, a string intended to uniquely identify each annotation
within a page.
- getAnnotations() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the list of FDF Annotations.
- getAnnotations() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will return a list of the Annotations for this page.
- getAntiAlias() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
This will return a boolean flag indicating whether to antialias the shading pattern.
- getAntiAlias() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will return the AntiAlias value.
- getAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will get the appearance dictionary associated with this annotation.
- getAppearanceCharacteristics() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Returns the appearance characteristics dictionary.
- getAppearanceDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the appearance dictionary that specifies the appearance of
a pushbutton field.
- getAppearanceStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will get the name of the current appearance stream if any.
- getAppearanceStreamReference() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get named page references..
- getARange() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will get the valid range for the a component.
- getAreas() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the areas.
- getArrayOfString(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets an array of strings.
- getArtBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A rectangle, expressed in default user space units, defining
the extent of the page's meaningful content (including potential
white space) as intended by the page's creator The default isthe CropBox.
- getArticleEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the end of an article.
- getArticleStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the beginning of an article.
- getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the ascent for the font.
- getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the ascent for the font.
- getAscent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the ascent for the font.
- getAsStream() - Method in class org.apache.pdfbox.pdmodel.common.PDTextStream
-
This is the preferred way of getting data with this class as it uses
a stream object.
- getAsString() - Method in class org.apache.pdfbox.pdmodel.common.PDTextStream
-
This will get this value as a string.
- getAttachmentName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
This is the name used to draw the type of attachment.
- getAttributeNames() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Gets the attribute names.
- getAttributes() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the attributes together with their revision numbers (A).
- getAttributes() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will get the attributes that are associated with the deviceN
color space.
- getAttributeValue(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Gets the attribute value for a given name.
- getAttributeValue(String, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Gets the attribute value for a given name.
- getAuthor() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the author of the document.
- getAutomaticStrokeAdjustment() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the automatic stroke adjustment flag.
- getAverageCharTolerance() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Get the current character width-based tolerance value that is being used
to estimate where spaces in text should be added.
- getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will get the average font width for all characters.
- getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the average font width for all characters.
- getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will get the average font width for all characters.
- getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
This will get the average font width for all characters.
- getAverageFontWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the average font width for all characters.
- getAverageFontWidthFromAFMFile() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will attempt to get the average font width from an AFM file.
- getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the average width for the font.
- getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the average width for the font.
- getAverageWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the average width for the font.
- getAwtFont(String) - Static method in class org.apache.pdfbox.pdmodel.font.FontManager
-
Get the font for the given fontname.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
-
Returns the AWT font that corresponds with this CIDFontType0 font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
-
Looks up, creates, returns the AWT Font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
Looks up, creates, returns the AWT Font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
-
Looks up, creates, returns the AWT Font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
Looks up, creates, returns the AWT Font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
Looks up, creates, returns the AWT Font.
- getawtFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
-
Looks up, creates, returns the AWT Font.
- getB() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will get the b value of the tristimulus.
- getBackground() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will return the background.
- getBackground() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the background color.
- getBackgroundColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the background colour (BackgroundColor).
- getBase() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
- getBase() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
This will get the base URI to be used in resolving relative URI references.
- getBaseColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will get the color space that acts as the index for this color space.
- getBaseFont() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
The PostScript name of the font.
- getBaselineShift() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the distance by which the element???s baseline shall be shifted
relative to that of its parent element (BaselineShift).
- getBaseState() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Returns the base state for optional content groups.
- getBBox() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
-
Gets the artifact's bounding box (BBox).
- getBBox() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the bounding box.
- getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
An array of four numbers in the form coordinate system (see
below), giving the coordinates of the left, bottom, right, and top edges,
respectively, of the pattern's bounding box.
- getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
An array of four numbers in the form coordinate system (see
below), giving the coordinates of the left, bottom, right, and top edges,
respectively, of the shadings's bounding box.
- getBBox() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
An array of four numbers in the form coordinate system (see
below), giving the coordinates of the left, bottom, right, and top edges,
respectively, of the form XObject's bounding box.
- getBBox() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will retrieve the rectangle specifying the location of the viewport.
- getBefore() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This will get the javascript that is executed before the import.
- getBeforeColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Gets the colour for the before edge.
- getBitCount() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Returns the number of bits maintained by this array.
- getBitsInChunk() - Method in class org.apache.pdfbox.io.NBitInputStream
-
Getter for property bitsToRead.
- getBitsInChunk() - Method in class org.apache.pdfbox.io.NBitOutputStream
-
Getter for property bitsToRead.
- getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
The bits per component of this shading.
- getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
The bits per component of this shading.
- getBitsPerComponent() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
The bits per component of this image.
- getBitsPerComponent() - Method in class org.apache.pdfbox.util.ImageParameters
-
The bits per component of this image.
- getBitsPerCoordinate() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
The bits per coordinate of this shading.
- getBitsPerCoordinate() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
The bits per coordinate of this shading.
- getBitsPerFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
The bits per flag of this shading.
- getBitsPerSample() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Get the number of bits that the output value will take up.
- getBl() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the annotation
loses the input focus.
- getBlackPoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will return the BlackPoint tristimulus.
- getBlackPoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will return the BlackPoint tristimulus.
- getBlackPoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will return the BlackPoint tristimulus.
- getBleedBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A rectangle, expressed in default user space units, defining
the region to which the contents of the page should be clipped
when output in a production environment.
- getBlockAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the alignment, in the block-progression direction, of content within
the table cell (BlockAlign).
- getBoolean(boolean) - Static method in class org.apache.pdfbox.cos.COSBoolean
-
This will get the boolean value.
- getBoolean(Boolean) - Static method in class org.apache.pdfbox.cos.COSBoolean
-
This will get the boolean value.
- getBoolean(String, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a cos boolean and convert it to a primitive boolean.
- getBoolean(COSName, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a COSBoolean and convert it to a primitive boolean.
- getBoolean(COSName, COSName, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a COSBoolean and convert it to a primitive boolean.
- getBorderColors() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the border colour (BorderColor).
- getBorderColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the border color.
- getBorderEffect() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will retrieve the border effect dictionary, specifying effects to be
applied used in drawing the line.
- getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the border style (BorderStyle).
- getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
- getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
- getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
- getBorderStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
This will retrieve the border style dictionary, specifying the width and
dash pattern used in drawing the line.
- getBorderThickness() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the border thickness (BorderThickness).
- getBottom() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Get the bottom y coordinate.
- getBottomStatusPanel() - Method in class org.apache.pdfbox.PDFReader
-
Get the bottom status panel.
- getBoundingBox() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
Get the bounding box for this appearance.
- getBounds() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
-
Returns all bounds values as COSArray.
- getBpp() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- getBRange() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will get the valid range for the b component.
- getByteArray() - Method in class org.apache.pdfbox.io.FastByteArrayOutputStream
-
This will get the underlying byte array.
- getByteArray() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will copy the stream into a byte array.
- getByteArray() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will copy the stream into a byte array.
- getByteCount() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Returns the size of the byte buffer for this array.
- getByteOffset() - Method in class org.apache.pdfbox.pdmodel.common.XrefEntry
-
- getByteRange() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Read out the byterange from the file
- getBytes() - Method in class org.apache.pdfbox.cos.COSString
-
This will get the bytes of the string.
- getBytes(String) - Static method in class org.apache.pdfbox.util.StringUtil
-
Converts a string to it ISO-8859-1 byte sequence
It is an workaround for variable initialisations outside of functions.
- getC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will get a JavaScript action to be performed in order to recalculate
the value of this field when that of another field changes.
- getC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
This will get an action to be performed when the page
is closed.
- getC0() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
-
Returns the C0 values of the function, 0 if empty.
- getC1() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
-
Returns the C1 values of the function, 1 if empty.
- getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the CapHeight for the font.
- getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the CapHeight for the font.
- getCapHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the CapHeight for the font.
- getCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve if the contents are shown as a caption or not.
- getCaptionHorizontalOffset() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the horizontal offset of the caption.
- getCaptionPositioning() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the caption positioning.
- getCaptionVerticalOffset() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the vertical offset of the caption.
- getCatalog() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the document catalog.
- getCatalog() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will get the FDF Catalog.
- getCertificate() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
-
Returns the certificate contained in the keystore.
- getChangeXs() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the changes along the x-axis.
- getChangeYs() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the changes along the y-axis.
- getCharacter(int) - Method in class org.apache.pdfbox.encoding.Encoding
-
This will get the character from the code.
- getCharacter(String) - Method in class org.apache.pdfbox.encoding.Encoding
-
This will get the character from the name.
- getCharacter() - Method in class org.apache.pdfbox.util.TextPosition
-
Return the string of characters stored in this object.
- getCharactersByArticle() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Character strings are grouped by articles.
- getCharacterSpacing() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the characterSpacing.
- getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the character set for the font.
- getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the character set for the font.
- getCharSet() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the character set for the font.
- getCheckedState() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Gets the checked state.
- getCheckSum() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the check sum of the embedded file.
- getChild(Object, int) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Returns the child of parent at index index
in the parent's
child array.
- getChildCount(Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Returns the number of children of parent.
- getClassNames() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the class names together with their revision numbers (C).
- getClearFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the ClrFf entry of the cos dictionary.
- getClearWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the ClrF entry of the cos dictionary.
- getCode(String) - Method in class org.apache.pdfbox.encoding.Encoding
-
This will get the character code for the name.
- getCodeFromArray(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Used for multibyte encodings.
- getCodePoints() - Method in class org.apache.pdfbox.util.TextPosition
-
Return the codepoints of the characters stored in this object.
- getCodeToNameMap() - Method in class org.apache.pdfbox.encoding.Encoding
-
Returns an unmodifiable view of the Code2Name mapping.
- getColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the color to be used for drawing text and the default value for the
colour of table borders and text decorations (Color).
- getColor(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a colour.
- getColor() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Get the annotation color.
- getColorantName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will get the separation name.
- getColorantNames() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will get the colorant names.
- getColorants() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
-
This will get a map of colorants.
- getColorModel() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
- getColorModel() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
- getColorOrFourColors(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a single colour or four colours.
- getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will get the current colorspace.
- getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
This will return the Color Space.
- getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will get the color space or null if none exists.
- getColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
This will get the color space or null if none exists.
- getColorSpace() - Method in class org.apache.pdfbox.util.ImageParameters
-
This will get the color space or null if none exists.
- getColorSpace(Map) - Method in class org.apache.pdfbox.util.ImageParameters
-
This will get the color space or null if none exists.
- getColorSpaces() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of colorspaces.
- getColorSpaces() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getColorSpaceValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will get the color space values.
- getColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will retrieve the colour used in drawing various elements.
- getColSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the number of columns in the enclosing table that shall be spanned
by the cell (ColSpan).
- getColSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Gets the number of columns in the enclosing table that shall be spanned
by the cell (ColSpan).
- getColumnCount() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the number of columns in the content of the grouping element
(ColumnCount).
- getColumnGap() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the desired space between adjacent columns in the inline-progression
direction (ColumnGap).
- getColumnWidths() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the desired width of the columns, measured in default user space
units in the inline-progression direction (ColumnWidths).
- getConstantOpacity() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the constant opacity value used when rendering the
annotation (excluing any popup).
- getContainedObjectNumbers(int) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Returns object numbers which are referenced as contained
in object stream with specified object number.
- getContents() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the contents of the marked content sequence.
- getContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Get the "contents" of the field.
- getContents(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Will return the embedded signature between the byterange gap.
- getContents(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Will return the embedded signature between the byterange gap.
- getContents() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will get the contents of the PDF Page, in the case that the contents
of the page is an array then then the entire array of streams will be
be wrapped and appear as a single stream.
- getContext() - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
-
Get the context for processing.
- getConversionFactor() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the conversion factor.
- getConverter(String) - Static method in class org.apache.pdfbox.encoding.conversion.EncodingConversionManager
-
Get converter from given encoding name.
- getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Returns the coordinate array used by several of the gradient types.
- getCoords() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
This will get the Coords values for this shading.
- getCoordSystemOrigin() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the origin of the coordinate system.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
-
This will get the underlying array value.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
This will get the underlying array value.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the underlying array for this rectangle.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
Convert this standard java object to a COS object.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
Convert this standard java object to a COS object.
- getCOSArray() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Convert this standard java object to a COS object.
- getCOSColorSpaceValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will get the color space values.
- getCOSDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
Get the line dash pattern as a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
Gets the COS dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Returns the underlying dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
This will get the dictionary associated with this crypt filter dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will get the dictionary associated with this encryption dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the dictionary for this object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
-
This will get the underlying cos dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will get the underlying dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the underlying dictionary that this class acts on.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will get the underlying dictionary.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Convert this standard java object to a COS object.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will get the underlying dictionary that this class acts on.
- getCOSDictionary() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the underlying dictionary.
- getCOSObject() - Method in class org.apache.pdfbox.cos.COSBase
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.AFMEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.DictionaryEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.MacRomanEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.PdfDocEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.StandardEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.Type1Encoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.encoding.WinAnsiEncoding
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.COSObjectable
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Returns the COSObject.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDTextStream
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPageInfo
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Returns the stream.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Interface method for COSObjectable.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
returns the dictionary.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
returns the dictionary.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
returns the dictionary.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
Convert this standard java object to a COS object.
- getCOSObject() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
Convert this standard java object to a COS object.
- getCOSStream() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Returns the stream.
- getCount() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will get the count of descendent page objects.
- getCreationDate() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the creation date of the embedded file.
- getCreationDate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
The annotation create date.
- getCreationDate() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the date and time the annotation was created.
- getCreationDate() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the creation date of the document.
- getCreator() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the creator of the document.
- getCropBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A rectangle, expressed in default user space units,
defining the visible region of default user space.
- getCropBox() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will get the CropBox at this page and not look up the hierarchy.
- getCryptFilterDictionary(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Returns the crypt filter with the given name.
- getCryptFilterMethod() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
This will return the crypt filter method.
- getCurrentAccessPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
Returns the access permissions that were computed during document decryption.
- getCurrentAccessPermission() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Returns the access permissions granted when the document was decrypted.
- getCurrentClippingPath() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will get the current clipping path.
- getCurrentPage() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Get the current page that is being processed.
- getCurrentPageNo() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Get the current page number that is being processed.
- getCurrentTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
- getCurrentTransformationMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the CTM.
- getCustomMetadataValue(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the value of a custom metadata information field for the document.
- getCYX() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the CYX factor.
- getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the mouse button
is pressed inside the annotation's active area.
- getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get the string specifying the default directory in standard DOS syntax.
- getD() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will get the destination to jump to.
- getDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
This will return a list of java.lang.Integer objects that represent the line
dash pattern appearance.
- getDashStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will retrieve the dash style used for drawing the border.
- getData() - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Returns the underlying byte buffer.
- getDate(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getDate(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getDate(String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a date.
- getDate(COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a date.
- getDate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Modification date.
- getDecimalSeparator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the text to be used as the decimal point in displaying numerical values.
- getDecode() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Returns the Decode Array of an XObjectImage.
- getDecodedStreamLength() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the decoded stream length.
- getDecodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Get the decode for the input parameter.
- getDecodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
Get the decode for the input parameter.
- getDecodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
Get the decode for the input parameter.
- getDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Get the list of decode parameters.
- getDecodeParams() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
-
DecodeParms is an optional parameter for filters.
- getDecodeParms() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the list of decode parameters.
- getDecryptionCertificate() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
-
Getter of the property decryptionCertificate.
- getDefaultAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
- getDefaultAppearanceString() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
This will get the string of default appearance string.
- getDefaultResources() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will get the default resources for the acro form.
- getDefaultWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will get the default width.
- getDenominator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the precision or denominator of a fractional amount.
- getDescendantFont() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
Provides the descendant font.
- getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the descent for the font.
- getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the descent for the font.
- getDescent() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the descent for the font.
- getDescription() - Method in class org.apache.pdfbox.util.ExtensionFileFilter
- getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
-
This will get the destination to jump to.
- getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Get the destination to be displayed when the annotation is activated.
- getDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the page destination of this node.
- getDestination() - Method in class org.apache.pdfbox.util.PDFCloneUtility
-
Returns the destination PDF document this cloner instance is set up for.
- getDestinationFileName() - Method in class org.apache.pdfbox.util.PDFMergerUtility
-
Get the name of the destination file.
- getDestinationStream() - Method in class org.apache.pdfbox.util.PDFMergerUtility
-
Get the destination OutputStream.
- getDests() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Get the destination named tree node.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get the dictionary that is associated with this stream.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Returns the stream.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Convert this standard java object to a COS object.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Convert this standard java object to a COS object.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
Returns the corresponding dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
returns the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Convert this standard java object to a COS dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will get the dictionary that this form wraps.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will get the dictionary associated with this field.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
This will return the corresponding dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will return the corresponding dictionary.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
This will get the underlying dictionary that this object wraps.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
This will get the underlying dictionary that this object wraps.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
This will get the underlying dictionary that this object wraps.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the underlying dictionary that this object wraps.
- getDictionary() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will get the underlying dictionary that this class acts on.
- getDictionary() - Method in class org.apache.pdfbox.util.ImageParameters
-
This will get the dictionary that stores the image parameters.
- getDictionaryObject(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will get an object from this dictionary.
- getDictionaryObject(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
- getDictionaryObject(COSName, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
- getDictionaryObject(String[]) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
- getDictionaryObject(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will get an object from this dictionary.
- getDictionaryObject(COSName) - Method in class org.apache.pdfbox.cos.COSDictionaryLateBinding
-
This will get an object from this dictionary.
- getDictionaryObject(COSName) - Method in class org.apache.pdfbox.cos.COSObject
-
This will get the dictionary object in this object that has the name key and
if it is a pdfobjref then it will dereference that and return it.
- getDictionaryObject(COSName) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get an object from this streams dictionary and dereference it
if necessary.
- getDifferences() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the incremental updates since the PDF was last opened.
- getDir() - Method in class org.apache.pdfbox.util.TextPosition
-
Return the direction/orientation of the string in this object
based on its text matrix.
- getDirectory() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
The dir to launch from.
- getDistances() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the distances.
- getDocument() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
This will get the document that was parsed.
- getDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will get the document that was parsed.
- getDocument() - Method in class org.apache.pdfbox.pdfparser.VisualSignatureParser
-
Returns the underlying COSDocument.
- getDocument() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will get the low level document.
- getDocument() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will get the document associated with this form.
- getDocument() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will get the low level document.
- getDocument() - Method in class org.apache.pdfbox.util.LayerUtility
-
Returns the PDF document we work on.
- getDocumentCatalog() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will get the document CATALOG.
- getDocumentID() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the document ID.
- getDocumentInformation() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will get the document info dictionary.
- getDocumentOutline() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the outline associated with this document or null if it
does not exist.
- getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Returns the Domain array used by several of the gradient types.
- getDomain() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.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.
- getDomainForInput(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will get the range for a certain input parameter.
- getDownAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will return a list of appearances.
- getDP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will get a JavaScript action to be performed
after printing a document.
- getDropThreshold() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
the minimum whitespace, as a multiple
of the max height of the current characters
beyond which the current line start is considered
to be a paragraph start.
- getDS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will get a JavaScript action to be performed
after saving a document.
- getDuplex() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the Duplex preference.
- getE() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the cursor
enters the annotation's active area.
- getElementIdentifier() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the element identifier (ID).
- getEmbedded() - Method in exception org.apache.pdfbox.exceptions.CryptographyException
-
This will get the exception that caused this exception.
- getEmbeddedDate(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEmbeddedDate(String, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEmbeddedDate(String, String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a date.
- getEmbeddedDate(String, COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a date.
- getEmbeddedFDFs() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the list of embedded FDF entries, or null if the entry is null.
- getEmbeddedFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Get the embedded file.
- getEmbeddedFileDos() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Get the embedded dos file.
- getEmbeddedFileMac() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Get the embedded Mac file.
- getEmbeddedFiles() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Get the embedded files named tree node.
- getEmbeddedFileUnix() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Get the embedded Unix file.
- getEmbeddedInt(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Get an integer from an embedded dictionary.
- getEmbeddedInt(String, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Get an integer from an embedded dictionary.
- getEmbeddedInt(String, String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Get an integer from an embedded dictionary.
- getEmbeddedInt(String, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Get an integer from an embedded dictionary.
- getEmbeddedString(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEmbeddedString(String, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEmbeddedString(String, String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEmbeddedString(String, COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getEncode() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
-
Returns all encode values as COSArray.
- getEncodeForParameter(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Get the encode for the input parameter.
- getEncoding(COSName) - Method in class org.apache.pdfbox.encoding.EncodingManager
-
This will get an encoding by name.
- getEncoding() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
The encoding to be used for a FDF field.
- getEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
cache the
COSName.ENCODING object from
the font's dictionary since it is called so often.
- getEncryptionDictionary() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the encryption dictionary if the document is encrypted or null
if the document is not encrypted.
- getEncryptionDictionary(COSDictionary) - Static method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionManager
-
Deprecated.
This will get the correct security handler for the encryption dictionary.
- getEncryptionDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will get the encryption dictionary for this document.
- getEncryptionKeyLength() - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
-
Get the length of the secrete key that will be used to encrypt
document data.
- getEndBookmark() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Get the bookmark where text extraction should end, inclusive.
- getEndColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Gets the colour for the end edge.
- getEndIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the distance from the end edge of the BLSE to that of the reference
area in the inline-progression direction (EndIndent).
- getEndPage() - Method in class org.apache.pdfbox.util.PageExtractor
-
Gets the last page number (inclusive) to be extracted.
- getEndPage() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will get the last page that will be extracted.
- getEndPage() - Method in class org.apache.pdfbox.util.Splitter
-
This will return the end page.
- getEndPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the line ending style for the end point,
possible values shown in the LE_ constants section.
- getErrNo() - Method in exception org.apache.pdfbox.exceptions.SignatureException
-
A error number to fulfill this exception
- getExecuteParam() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
A parameter to pass the executable.
- getExpandedForm() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the expanded form (E).
- getExpandedForm() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the expanded form (E).
- getExpectedLength() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
-
This will get the length that the PDF document specified this stream
should be.
- getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Returns the Extend array used by several of the gradient types.
- getExtend() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
This will get the optional Extend values for this shading.
- getExtendedGraphicsState() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will get the extended graphics state for this pattern.
- getExtends() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
A reference to an object stream, of which the current object stream is
considered an extension.
- getExternalData() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will return the external data dictionary.
- getF() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Get the F action.
- getF() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will get a JavaScript action to be performed before
the field is formatted to display its current value.
- getF() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get the file name to be launched or the document to be opened
or printed, in standard Windows pathname format.
- getFDF() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will get the FDF dictionary.
- getFDFDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will get the FDF document that was parsed.
- getField(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will get a field by name, possibly using the cache if setCache is true.
- getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the Ff entry of the cos dictionary.
- getFieldFlags() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will get the flags for this field.
- getFields() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the list of FDF Fields.
- getFields() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
This will get a list of fields that are part of this template.
- getFields() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will return all of the fields in the document.
- getFieldType() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Get the FT entry of the field.
- getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will get the file name.
- getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
-
This will get the file name.
- getFile() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
-
This will get the file name.
- getFile() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will get the file specification for this stream.
- getFile() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will get the file specification for this stream.
- getFile() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
The source file or target file: the PDF document file that
this FDF file was exported from or is intended to be imported into.
- getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get the application to be launched or the document
to be opened or printed.
- getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will get the file in which the destination is located.
- getFile() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
Return the attached file.
- getFileDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Get the list of decode parameters.
- getFileDecodeParams() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the list of decode parameters.
- getFileDos() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will get the name representing a Dos file.
- getFileFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will get the list of filters that are associated with this stream.
- getFileFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will get the list of filters that are associated with this stream.
- getFileInBytes(int[]) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
-
- getFileMac() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will get the name representing a Mac file.
- getFilename() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
The file to launch.
- getFilePointer() - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
-
Returns offset in file at which next byte would be read.
- getFileSpecification() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
This will get the file specification of this reference.
- getFileUnix() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will get the name representing a Unix file.
- getFilter(COSName) - Method in class org.apache.pdfbox.filter.FilterManager
-
This will get a filter by name.
- getFilter(String) - Method in class org.apache.pdfbox.filter.FilterManager
-
This will get a filter by name.
- getFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Get the name of the filter.
- getFilter() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
Get the name of the filter.
- getFilter(int) - Static method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- getFilter() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getFilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
-
This will get the stream with all of the filters applied.
- getFilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get the stream with all of the filters applied.
- getFilterInputStream(int[]) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
-
- getFilterManager() - Method in class org.apache.pdfbox.cos.COSBase
-
This will get the filter manager to use to filter streams.
- getFilters() - Method in class org.apache.pdfbox.cos.COSStream
-
This will return the filters to apply to the byte stream.
- getFilters() - Method in class org.apache.pdfbox.filter.FilterManager
-
This will get all of the filters that are available in the system.
- getFilters() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will return the filters to apply to the byte stream
the method will return
- getFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will get the list of filters that are associated with this stream.
- getFilters() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will get the list of filters that are associated with this stream.
- getFilters() - Method in class org.apache.pdfbox.util.ImageParameters
-
This will get the list of filters that are associated with this stream.
- getFirstBead() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Get the first bead in the thread, or null if it has not been set yet.
- getFirstByteOffset() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
The byte offset (in the decoded stream) of the first compressed object.
- getFirstChar() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
The code for the first char or -1 if there is none.
- getFirstChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Return the first child or null if there is no child.
- getFirstCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.DualCOSObjectable
-
Convert this standard java object to a COS object.
- getFirstCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
Convert this standard java object to a COS object.
- getFlag(COSDictionary, String, int) - Static method in class org.apache.pdfbox.util.BitFlagHelper
-
Deprecated.
use #getFlag(COSDictionary, COSName, boolean) using COSName constants instead
- getFlag(COSDictionary, COSName, int) - Static method in class org.apache.pdfbox.util.BitFlagHelper
-
Gets the boolean value from the flags at the given bit
position.
- getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the font flags.
- getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the font flags.
- getFlags() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the font flags.
- getFlatness() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
get the value of the flatness property.
- getFlatnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the flatness tolerance.
- getFloat(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an float
- getFloat(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an float
- getFloat(String, float) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a float.
- getFloat(COSName, float) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an float.
- getFo() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the annotation
receives the input focus.
- getFont() - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
This will get the font for this font setting.
- getFont() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the font.
- getFont() - Method in class org.apache.pdfbox.TextToPDF
-
- getFont() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the font for the text being drawn.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will get the fonts bouding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the fonts bounding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the fonts bouding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the fonts bouding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the fonts bounding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will get the fonts bounding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
This will get the fonts bounding box.
- getFontBoundingBox() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the fonts bounding box.
- getFontDescriptor() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the font descriptor for this font.
- getFontEncoding() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get or create the encoder.
- getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A string representing the preferred font family.
- getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
A string representing the preferred font family.
- getFontFamily() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
A string representing the preferred font family.
- getFontFile() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
A stream containing a Type 1 font program.
- getFontFile2() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
A stream containing a true type font program.
- getFontFile3() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
A stream containing a font program that is not true type or type 1.
- getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will get the font height for a character.
- getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the font width for a character.
- getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will get the font height for a character.
- getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
This will get the font height for a character.
- getFontHeight(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the font height for a character.
- getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the matrix that is used to transform glyph space to
text space.
- getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the matrix that is used to transform glyph space to
text space.
- getFontMatrix() - Method in class org.apache.pdfbox.pdmodel.font.PDType1Font
-
This will get the matrix that is used to transform glyph space to
text space.
- getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
Get the font name.
- getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
Get the font name.
- getFontName() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Get the font name.
- getFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
- getFonts() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of fonts.
- getFonts() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getFontSetting() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the font setting of the graphics state.
- getFontSize() - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
This will get the size of the font.
- getFontSize() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the fontSize.
- getFontSize() - Method in class org.apache.pdfbox.TextToPDF
-
- getFontSize() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the font size that this object is
suppose to be drawn at.
- getFontSizeInPt() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the font size in pt.
- getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A string representing the preferred font stretch.
- getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
A string representing the preferred font stretch.
- getFontStretch() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
A string representing the preferred font stretch.
- getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
The weight of the font.
- getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
The weight of the font.
- getFontWeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
The weight of the font.
- getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will get the font width for a character.
- getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
Determines the width of the given character.
- getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the font width for a character.
- getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Determines the width of the given character.
- getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will get the font width for a character.
- getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
This will get the font width for a character.
- getFontWidth(int) - Method in class org.apache.pdfbox.pdmodel.font.PDType0Font
-
Determines the width of the given character.
- getFontWidth(byte[], int, int) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the font width for a character.
- getFontWidthFromAFMFile(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will attempt to get the font width from an AFM file.
- getFormattedValue() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Returns the string for the property value.
- getFormType() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
This will get the form type, currently 1 is the only form type.
- getFractionalDisplay() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the value for the manner to display a fractional value.
- getFractionalSpaceToAllocate() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This is guaranteed to never return null.
- getFullyQualifiedName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Returns the fully qualified name of the field, which is a concatenation of
the names of all the parents fields.
- getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Returns the function used by several of the gradient types.
- getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
This will return the function used to convert the color values.
- getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
This will return the function used to convert the color values.
- getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
This will return the function used to convert the color values.
- getFunction() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
This will return the function used to convert the color values.
- getFunctions() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
-
Returns all functions values as COSArray.
- getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Returns the function type.
- getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Returns the function type.
- getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
-
Returns the function type.
- getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
-
Returns the function type.
- getFunctionType() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
-
Returns the function type.
- getG() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will get the g value of the tristimulus.
- getGamma() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will get the gamma value.
- getGamma() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will get the gamma value.
- getGeneration() - Method in class org.apache.pdfbox.cos.COSUnread
-
- getGeneration() - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
-
This will get the generation number.
- getGenerationNumber() - Method in class org.apache.pdfbox.cos.COSObject
-
Getter for property generationNumber.
- getGlyphOrientationVertical() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the orientation of glyphs when the inline-progression direction is
top to bottom or bottom to top (GlyphOrientationVertical).
- getGraphics() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Get the graphics that we are currently drawing on.
- getGraphicsStack() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getGraphicsState() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getGraphicsStates() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of graphic states.
- getGraphicsStates() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getGroup(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Returns the optional content group of the given name.
- getGroupNames() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Lists all optional content group names.
- getGuidelineColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Get the color to be used for the guidelines.
- getGuidelineStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Get the style for the guideline.
- getGuidelineWidth() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Get the width of the of the guideline in default user space units.
- getHeaders() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the headers (Headers).
- getHeaders() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Gets the headers (Headers).
- getHeaderString() - Method in class org.apache.pdfbox.cos.COSDocument
-
- getHeight() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the height of this rectangle as calculated by
upperRightY - lowerLeftY.
- getHeight() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the height of the element???s content rectangle in the
block-progression direction (Height).
- getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- getHeight() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Get the height of the image.
- getHeight() - Method in class org.apache.pdfbox.util.ImageParameters
-
The height of this image.
- getHeight() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the maximum height of all characters in this string.
- getHeightDir() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the maximum height of all characters in this string.
- getHexString() - Method in class org.apache.pdfbox.cos.COSString
-
This will take this string and create a hex representation of the bytes that make the string.
- getHighlightingMode() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Returns the highlighting mode.
- getHighlightMode() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Set the highlight mode for when the mouse is depressed.
- getHighValue() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
Get the highest value for the lookup.
- getHorizontalScalingPercent() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the horizontalScaling.
- getIconFit() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the icon fit that is associated with this field.
- getID() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This is the FDF id.
- getIDTree() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Returns the ID tree.
- getImageData() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
-
Get the bytes for the image.
- getImageData() - Method in class org.apache.pdfbox.util.PDFOperator
-
This is the special case for the ID operator where there are just random
bytes inlined the stream.
- getImageMask() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Get the ImageMask flag.
- getImageParameters() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
-
This will get the image parameters.
- getImageParameters() - Method in class org.apache.pdfbox.util.PDFOperator
-
This will get the image parameters, this is only valid for BI operators.
- getImages() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of images.
- getIndentThreshold() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
returns the multiple of whitespace character widths
for the current text which the current
line start can be indented from the previous line start
beyond which the current line start is considered
to be a paragraph start.
- getIndex() - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
-
This will get the index of the array entry.
- getIndexOfChild(Object, Object) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Returns the index of child in parent.
- getIndividualWidths() - Method in class org.apache.pdfbox.util.TextPosition
-
Get the widths of each individual character.
- getInlineAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the alignment, in the inline-progression direction, of content
within the table cell (InlineAlign).
- getInputStreamAsString() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
A convenience method to get this stream as a string.
- getInReplyTo() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
- getInstance() - Static method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
-
Get the singleton instance.
- 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(String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getInt(COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getInt(COSName, COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getInt(COSName, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getInteger(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets an integer.
- getIntensity() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
This will retrieve the intensity of the applied effect.
- getIntent() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the intent of the annotation The values and meanings
are specific to the actual annotation See the IT_* constants for the
annotation classes.
- getInteriorColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the interior colour of the line endings defined in the
LE entry.
- getInteriorColour() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will retrieve the interior colour of the drawn area
Colour is in DeviceRGB colourspace.
- getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the italic angle for the font.
- getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the italic angle for the font.
- getItalicAngle() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the italic angle for the font.
- getItem(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will do a lookup into the dictionary.
- getItem(COSName) - Method in class org.apache.pdfbox.cos.COSObject
-
This will get the dictionary object in this object that has the name key.
- getItem(COSName) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get an object from this streams dictionary.
- getJavaColor() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
Returns the Java AWT color based on the current color space and value.
- getJavaColorSpace() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
-
Returns the Java AWT color space for this instance.
- getJavaScript() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the java script entry.
- getJavaScript() - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Get the document level javascript entries.
- getK() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will get a JavaScript action to be performed when the user
types a keystroke into a text field or combo box or modifies the
selection in a scrollable list box.
- getKey() - Method in class org.apache.pdfbox.pdfviewer.MapEntry
-
Get the key for this entry.
- getKey() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
This will get the Object key.
- getKeyForValue(Object) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Search in the map for the value that matches the parameter
and return the first key that maps to that value.
- getKeyLength() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
Getter of the property keyLength.
- getKeywords() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the keywords of the document.
- getKids() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Return the children of this node.
- getKids() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Return the children of this node.
- getKids() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Returns a list of objects for the kids (K).
- getKids() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the list of kids.
- getKids() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will get all the kids of this field.
- getKids() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
-
This will return a list of PDField objects that are part of this radio collection.
- getKids() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will return all kids of this node, either PDPageNode or PDPage.
- getKnockoutFlag() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the knockout.
- getLabelPositionToValue() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return a value indicating the ordering of the label specified by U to the calculated unit value.
- getLabelPrefixString() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the text to be concatenated to the left of the label specified by U.
- getLabelsByPageIndices() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Returns a mapping with 0-based page indices as keys and corresponding
page labels as values as an array.
- getLabelSuffixString() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the text to be concatenated after the label specified by U.
- getLanguage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the language (Lang).
- getLanguage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the language (Lang).
- getLanguage() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
The language for the document.
- getLastChar() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
The code for the last char or -1 if there is none.
- getLastChild() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Return the last child or null if there is no child.
- getLastModified() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will get the date that the content stream was last modified.
- getLastSignatureDictionary() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will return the last signature dictionary.
- getLeaderLineExtensionLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the length of the leader line extensions.
- getLeaderLineLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the length of the leader line.
- getLeaderLineOffsetLength() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the length of the leader line offset.
- getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the leading for the font.
- getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the leading for the font.
- getLeading() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the leading for the font.
- getLeading() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the leading.
- getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
-
Get the left x coordinate.
- getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Get the left x coordinate.
- getLeft() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Get the left x coordinate.
- getLength() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
-
The number of bytes written to the stream.
- getLength() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will get the length of the filtered/compressed stream.
- getLength() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will get the length of the filtered/compressed stream.
- getLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
This will return the Length entry of the crypt filter dictionary.
- getLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will return the Length entry of the encryption dictionary.
- getLength() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will return the length of the content stream.
- getLength() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the length of the content stream.
- getLengthWritten() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
-
Get the amount of data that was actually written to the stream, in theory this
should be the same as the length specified but in some cases it doesn't match.
- getLine() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the start and end coordinates of the line (or leader
line if LL entry is set).
- getLinearInterpretation() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will get the linear interpretation array.
- getLineCap() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the line cap.
- getLineCapStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the line cap style.
- getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Get the line dash pattern for this box style.
- getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the dash pattern.
- getLineDashPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will get the current line dash pattern.
- getLineHeight() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the element???s preferred height in the block-progression direction
(LineHeight).
- getLineJoin() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the line join.
- getLineJoinStyle() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the line join style.
- getLineLength() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
-
This will get the length of the line.
- getLinePath() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Get the current line path to be drawn.
- getLineSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will get the line separator.
- getLineSloaps() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the sloaps of a line.
- getLineWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the line width.
- getLineWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the line width.
- getListItemPatterns() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
returns a list of regular expression Patterns representing
different common list item formats.
- getListNumbering() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the list numbering (ListNumbering).
- getListNumbering() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
-
Gets the list numbering (ListNumbering).
- getLocation() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getLong(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an long
- getLong(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an long
- getLong(String[], long) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an long.
- getLong(String, long) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getLong(COSName, long) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be an integer.
- getLookupData() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
Get the lookup data table.
- getLowerLeftX() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the lower left x coordinate.
- getLowerLeftY() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the lower left y coordinate.
- getLowerLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Get the lowest value for a key in the name map.
- getLowerLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Get the lowest value for a key in the name map.
- getMacCreator() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the mac Creator.
- getMacResFork() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the mac ResFork.
- getMacSubtype() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the mac subtype.
- getMarkedContents() - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
-
- getMarkInfo() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get info about doc's usage of tagged features.
- getMask() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Returns the optional mask of a XObjectImage if there is one.
- getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will get the optional Matrix of a Pattern.
- getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will get the optional Matrix of a Pattern.
- getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
This will get the optional Matrix of a function based shading.
- getMatrix() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
This will get the optional Matrix of an XObjectForm.
- getMax() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
This will get the maximum value of the range.
- getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the max width for the font.
- getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the max width for the font.
- getMaxWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the max width for the font.
- getMCID() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Gets the marked content identifier.
- getMCID() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the marked-content identifier.
- getMeasure() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will retrieve the measure dictionary.
- getMediaBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A rectangle, expressed
in default user space units, defining the boundaries of the physical
medium on which the page is intended to be displayed or printed
This will get the MediaBox at this page and not look up the hierarchy.
- getMediaBox() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will get the MediaBox at this page and not look up the hierarchy.
- getMessage() - Method in exception org.apache.pdfbox.exceptions.WrappedException
-
Gets the wrapped exception message.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Get the metadata that is part of the document catalog.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the metadata that is part of the document catalog.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will get the metadata stream for this object.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Get the metadata that is part of the document catalog.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the metadata that is part of the document catalog.
- getMetadata() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
Get the metadata that is part of the document catalog.
- getMetadataKeys() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the keys of all metadata information fields for the document.
- getMin() - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
This will get the minimum value of the range.
- getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the missing width for the font.
- getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the missing width for the font.
- getMissingWidth() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the missing width for the font.
- getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the miter limit.
- getMiterLimit() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the miter limit.
- getModDate() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the mod date of the embedded file.
- getModificationDate() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the modification date of the document.
- getModifiedDate() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will retrieve the date and time the annotation was modified.
- getN() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
-
Returns the exponent of the function.
- getName(int) - Method in class org.apache.pdfbox.cos.COSArray
-
Get the value of the array as a string.
- getName(int, String) - Method in class org.apache.pdfbox.cos.COSArray
-
Get an entry in the array that is expected to be a COSName.
- getName() - Method in class org.apache.pdfbox.cos.COSName
-
This will get the name of this COSName object.
- getName(int) - Method in class org.apache.pdfbox.encoding.Encoding
-
This will take a character code and get the name from the code.
- getName(int) - Method in class org.apache.pdfbox.encoding.WinAnsiEncoding
-
- getName() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
The name of the named text stream.
- getName() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Returns the property name.
- getName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a name value.
- getName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a name value.
- getName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Get the annotation name.
- getName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
This will get the name of the referenced page.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will return the name of the color space.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
Returns the name of the optional content group.
- getName() - Method in enum org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties.BaseState
-
Returns the PDF name for the state.
- getName() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
This will return the name of the object.
- getName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
This will retrieve the name (and hence appearance, AP taking precedence)
For this annotation.
- getName() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will retrieve the name (and hence appearance, AP taking precedence)
For this annotation.
- getName() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getName() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will retrieve the name of the viewport.
- getNameAsString(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getNameAsString(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getNameAsString(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getNameAsString(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getNamedDestination() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
This will get the name of the destination.
- getNamedJavaScripts() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This will return a list of PDNamedTextStream objects.
- getNameFromCharacter(char) - Method in class org.apache.pdfbox.encoding.Encoding
-
This will take a character code and get the name from the code.
- getNameOrArrayOfName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a name value or array of name values.
- getNames() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
This will return a map of names.
- getNames() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
- getNameToCodeMap() - Method in class org.apache.pdfbox.encoding.Encoding
-
Returns an unmodifiable view of the Name2Code mapping.
- getNext() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will get the next action, or sequence of actions, to be performed after this one.
- getNextBead() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
This will get the next bead.
- getNextSibling() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Return the next sibling or null if there is no next sibling.
- getNextUniqueKey(Map, String) - Static method in class org.apache.pdfbox.util.MapUtil
-
Generate a unique key for the map based on a prefix.
- getNodeValue(Element) - Static method in class org.apache.pdfbox.util.XMLUtil
-
This will get the text value of an element.
- getNonFullScreenPageMode() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the non full screen page mode preference.
- getNonStrokeAlphaConstants() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the non-stroke alpha constants property.
- getNonStrokeJavaComposite() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
- getNonStrokingAlpaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the non stroking alpha constant.
- getNonStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Returns the non-stroking color state.
- getNonStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint control for non stroking operations.
- getNormalAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will return a list of appearances.
- getNormalCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the normal caption.
- getNormalIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the normal icon.
- getNullEntry() - Static method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
This will return a null entry: 0000000000 65535 f
- getNumber() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get the current object number.
- getNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a number value.
- getNumber(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a number value.
- getNumber() - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
-
This will get the objects id.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceCMYK
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will return the number of color components.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will return the number of color components.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
-
This will get the number of components that this color space is made up of.
- getNumberOfComponents() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will get the number of components that this color space is made up of.
- getNumberOfInputParameters() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will get the number of input parameters that
have a domain specified.
- getNumberOfObjects() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
Get the number of compressed object.
- getNumberOfOutputParameters() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will get the number of output parameters that
have a range specified.
- getNumberOfPages() - Method in class org.apache.pdfbox.pdmodel.PDDocument
- getNumberOfPages() - Method in class org.apache.pdfbox.pdmodel.PDPageable
-
Returns the number of pages in the given PDF document.
- getNumberOrArrayOfNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a number or an array of numbers.
- getNumberOrName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a number or a name value.
- getNumbers() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
This will return a map of numbers.
- getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
This will get an action to be performed when the page
is opened.
- getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get the string specifying the operation to perform:
open to open a document
print to print a document
If the F entry designates an application instead of a document, this entry
is ignored and the application is launched.
- getObject(int) - Method in class org.apache.pdfbox.cos.COSArray
-
This will get an object from the array.
- getObject() - Method in class org.apache.pdfbox.cos.COSObject
-
This will get the object that this object encapsulates.
- getObject(long, long) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
- getObject() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
This will get the object.
- getObject(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
-
Returns the object at the specified position.
- getObjectByType(String) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the first dictionary object by type.
- getObjectByType(COSName) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the first dictionary object by type.
- getObjectFromPath(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Nice method, gives you every object you want
Arrays works properly too.
- getObjectFromPool(COSObjectKey) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get an object from the pool.
- getObjectFromPool(COSObjectKey) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
This will get an object from the pool.
- getObjectFromPool(long, long) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
This will get an object from the pool.
- getObjectKeys() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get all available object keys.
- getObjectKeysFromPool() - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
This will get an object from the pool.
- getObjectNumber() - Method in class org.apache.pdfbox.cos.COSObject
-
Getter for property objectNumber.
- getObjectNumber() - Method in class org.apache.pdfbox.cos.COSUnread
-
- getObjects() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get a list of all available objects.
- getObjects() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
-
This will get the objects that were parsed from the stream.
- getObjectsByType(String) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get all dictionary objects by type.
- getObjectsByType(COSName) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get a dictionary object by type.
- getOCProperties() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the optional content properties dictionary associated with this document.
- getOffset() - Method in class org.apache.pdfbox.io.PushBackInputStream
-
Returns the current byte offset in the file.
- getOffset() - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
This will get the offset into the document.
- getOffValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
-
This will get the value of the radio button.
- getOnValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
-
This will get the value of the radio button.
- getOpacity() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Get the opacity value.
- getOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
This will retrieve the initial state of the annotation, open Or closed
(default closed).
- getOpen() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will retrieve the initial state of the annotation, open Or closed
(default closed).
- getOpenAction() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the Document Open Action for this object.
- getOpenCount() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Get the number of open nodes.
- getOperation() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Get the operation to perform on the file.
- getOperation() - Method in class org.apache.pdfbox.util.PDFOperator
-
This will get the operation that this operator represents.
- getOperator(String) - Method in class org.apache.pdfbox.pdmodel.common.function.type4.Operators
-
Returns the operator for the given operator name.
- getOperator(String) - Static method in class org.apache.pdfbox.util.PDFOperator
-
This is used to create/cache operators in the system.
- getOperators() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
-
Returns the operator set used by this execution context.
- getOption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
This will get the string of one of the available options.
- getOptionalContentGroup(COSName) - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
-
Returns the optional content group belonging to the given resource name.
- getOptionalContentGroups() - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Returns the collection of all optional content groups.
- getOptions() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will return a list of options for a choice field.
- getOptions() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
-
This will get the option values "Opt" entry of the pdf button.
- getOutput() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get the output stream.
- getOutput() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
The output stream that is being written to.
- getOverprintMode() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint control mode.
- getOverprintMode() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
get the value of the overprint mode property.
- getOwner() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Returns the owner of the attributes.
- getOwnerAccessPermission() - Static method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
returns an access permission object for a document owner.
- getOwnerKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will get the O entry in the standard encryption dictionary.
- getOwnerKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will get the O entry in the standard encryption dictionary.
- getOwnerPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Getter of the property ownerPassword.
- getOwnerPasswordForEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Deprecated.
Do not rely on this method anymore.
- getOwnerUserProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
-
Returns the user properties.
- getP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get a parameter string to be passed to the application designated by the F entry.
- getPadding() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the padding (Padding).
- getPage(int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
Returns the page requested with all the objects loaded into it.
- getPage() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Get the page that is currently being drawn.
- getPage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Gets the page.
- getPage() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the page on which some or all of the content items designated by
the K entry shall be rendered (Pg).
- getPage() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
This will get the page number or null if it does not exist.
- getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will retrieve the corresponding page of this annotation.
- getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Get the page number.
- getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
This will get the page for this destination.
- getPage() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Get the page that this bead is part of.
- getPageCount() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Deprecated.
Use the getNumberOfPages method instead!
- getPageEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the end of a page.
- getPageFormat(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- getPageFormat(int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
-
Returns the format of the page at the given index.
- getPageIndicesByLabels() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Returns a mapping with computed page labels as keys and corresponding
0-based page indices as values.
- getPageInfo() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
This will get the FDF page info object.
- getPageLabelRange(int) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Returns the page label range starting at the given page, or null
if no such range is defined.
- getPageLabels() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Returns the page labels descriptor of the document.
- getPageLayout() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the page layout, see the PAGE_LAYOUT_XXX constants.
- getPageMap() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will return the Map containing the mapping from object-ids to pagenumbers.
- getPageMode() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the page display mode, see the PAGE_MODE_XXX constants.
- getPageNumber() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
Returns the number of pages in a document.
- getPageNumber() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
This will get the page number for this destination.
- getPageRangeCount() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Returns the number of page label ranges.
- getPages() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the list of FDF Pages.
- getPages() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
This will get the root node for the pages.
- getPageSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will get the page separator.
- getPageSize() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Get the size of the page that is currently being drawn.
- getPageStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the beginning of a page.
- getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
Returns the Java AWT paint based on the current pattern.
- getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will return the paint of the pattern.
- getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will return the paint of the pattern.
- getPaint(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the paint of the pattern.
- getPaintType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the paint type.
- getPanel() - Method in class org.apache.pdfbox.pdfviewer.PageWrapper
-
This will get the JPanel that can be displayed.
- getParagraphEnd() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the end of a paragraph.
- getParagraphStart() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Returns the string which will be used at the beginning of a paragraph.
- getParent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the parent in the structure hierarchy (P).
- getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
This will retrieve the markup annotation which this popup relates to.
- getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the parent of this object.
- getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Get the parent of this object.
- getParent() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Get the parent field to this field, or null if none exists.
- getParent() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This is the parent page node.
- getParent() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This is the parent page node.
- getParentTreeNextKey() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Returns the next key in the parent tree.
- getParser() - Method in class org.apache.pdfbox.cos.COSUnread
-
- getParser() - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
- getPartialFieldName() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the "T" entry in the field dictionary.
- getPartiallyFilteredStream(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will get a stream with some filters applied but not others.
- getPartiallyFilteredStream(List) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will get a stream with some filters applied but not others.
- getPartialName() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Returns the partial name of the field.
- getPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
-
Returns the password given by the user and that will be used
to open the private key.
- getPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
-
Returns the password.
- getPattern() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will get the current pattern.
- getPatterns() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of patterns.
- getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will return the pattern type.
- getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will return the pattern type.
- getPatternType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the pattern type.
- getPC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the page containing
the annotation is closed.
- getPDDocument() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
This will get the PD document that was parsed.
- getPDDocument() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
This will get the PD document that was parsed.
- getPDDocument() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will get the PD document that was parsed.
- getPDFName(String) - Static method in class org.apache.pdfbox.cos.COSName
-
This will get a COSName object with that name.
- getPDStream() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Returns the underlying PDStream.
- getPDStream() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
Get the pd stream for this icc color space.
- getPDStream() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Returns the stream.
- getPermission() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
-
Returns the access permission granted to the recipient.
- getPermissionBytes() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
The returns an integer representing the access permissions.
- getPermissionBytesForPublicKey() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
This returns an integer representing the access permissions.
- getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will get the permissions bit mask.
- getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will get the permissions bit mask.
- getPermissions() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Getter of the property permissions.
- getPhaseStart() - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
This will get the line dash pattern phase.
- getPI() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
- getPlacement() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the positioning of the element with respect to the enclosing
reference area and other content (Placement).
- getPO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the page containing
the annotation is opened.
- getPopup() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the popup annotation used for entering/editing the
text for this annotation.
- getPos() - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
-
This will get the current position in the stream.
- getPosition() - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
-
This will get the position in the RAF that the stream was written
to.
- getPredictor() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
-
A code that selects the predictor algorithm.
- getPreferedSignatureSize() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Get the preferred size of the signature.
- getPrefix() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Returns the page label prefix for this page range.
- getPreviousBead() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
This will get the previous bead.
- getPreviousSibling() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Return the previous sibling or null if there is no sibling.
- getPreviousURI() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will set the previous URI action, in case it's
needed.
- getPrintable(int) - Method in class org.apache.pdfbox.pdmodel.PDDocument
- getPrintable(int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
-
Returns a
Printable for the page at the given index.
- getPrintArea() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the PrintArea preference.
- getPrintClip() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the PrintClip preference.
- getPrinterJob() - Method in class org.apache.pdfbox.pdmodel.PDPageable
-
Returns the printer job for printing the given PDF document.
- getPrintScaling() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the PrintScaling preference.
- getPrivateKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
-
returns The private key that will be used to open the document protection.
- getProducer() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the producer of the document.
- getProperties() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the properties.
- getProperties() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
Returns the dictionary mapping resource names to property list dictionaries for marked
content.
- getPV() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the page containing
the annotation becomes visible in the viewer application's user interface.
- getQ() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
This will get the 'quadding' or justification of the text to be displayed.
0 - Left(default)
1 - Centered
2 - Right
Please see the QUADDING_CONSTANTS.
- getQuadPoints() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will retrieve the set of quadpoints which encompass the areas of
this annotation which will activate.
- getQuadPoints() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
This will retrieve the set of quadpoints which encompass the areas of
this annotation.
- getR() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will get the r value of the tristimulus.
- getRangeForComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will get the range for a certain component number.
- getRangeForOutput(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will get the range for a certain output parameters.
- getRangeValues() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Returns all ranges for the output values as COSArray .
- getRaster(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingContext
- getRaster(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingContext
- getReadingDirection() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the reading direction preference.
- getReason() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getRecipientsIterator() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
-
Returns an iterator to browse the list of recipients.
- getRecipientsLength() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Returns the number of recipients contained in the Recipients field of the dictionary.
- getRecipientsNumber() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
-
Returns the number of recipients.
- getRecipientStringAt(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
returns the COSString contained in the Recipients field at position i.
- getRectangle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
The rectangle associated with this annotation.
- getRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
The annotation rectangle, defining the location of the annotation
on the page in default user space units.
- getRectangle() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
The rectangle on the page that this bead is part of.
- getRectDifference() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will get the rectangle difference rectangle.
- getReferencedObject() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Gets a higher-level object for the referenced object.
- getRegions() - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
-
Get the list of regions that have been setup.
- getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the rendering intent.
- getRenderingIntent() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will get the rendering intent.
- getRenderingMode() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the renderingMode.
- getReplyType() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the Reply Type (relationship) with the annotation in
the IRT entry See the RT_* constants for the available values.
- getResources() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will get the resources for this pattern.
- getResources() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
This will get the resources at this page and not look up the hierarchy.
- getResources() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
This will get the resources for this appearance stream.
- getResources() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will get the resources at this page and not look up the hierarchy.
- getResources() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will get the resources at this page node and not look up the hierarchy.
- getResources() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getRevision() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will return the R entry of the encryption dictionary.
- getRevision() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will return the R entry of the encryption dictionary.
- getRevisionNumber() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the revision number (R).
- getRevisionNumber(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
-
Returns the revision number at the specified position.
- getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
-
Returns an image of the CCITT Fax, or null if TIFFs are not supported.
- getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
-
Returns an image of the JPeg, or null if JPegs are not supported.
- getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
-
Returns a
BufferedImage of the COSStream
set in the constructor or null if the COSStream could not be encoded.
- getRGBImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Returns an java.awt.Image, that can be used for display etc.
- getRichContents() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the rich text stream which is displayed in the popup
window.
- getRichText() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the rich text that is associated with this field.
- getRight() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Get the right x coordinate.
- getRise() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the rise.
- getRole() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Gets the role.
- getRoleMap() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Returns the role map.
- getRolloverAppearance() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will return a list of appearances.
- getRolloverCaption() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the rollover caption.
- getRolloverIcon() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the rollover icon.
- getRoot() - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Returns the root of the tree.
- getRotation() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will retrieve the rotation of the annotation widget.
- getRotation() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A value representing the rotation.
- getRotation() - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
A value representing the rotation.
- getRowSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the number of rows in the enclosing table that shall be spanned by
the cell (RowSpan).
- getRowSpan() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Gets the number of rows in the enclosing table that shall be spanned by
the cell (RowSpan).
- getRubyAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the justification of the lines within a ruby assembly (RubyAlign).
- getRubyPosition() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the placement of the RT structure element relative to the RB element
in a ruby assembly (RubyPosition).
- getS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will get the type of action that the actions dictionary describes.
- getS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will get the type of action that the actions dictionary describes.
- getSamples() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Get all sample values of this function.
- getScaleInstance(float, float) - Static method in class org.apache.pdfbox.util.Matrix
-
Convenience method to create a scaled instance.
- getScaleOption() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will get the scale option.
- getScaleRatio() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will return the scale ration.
- getScaleType() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will get the scale type.
- getScope() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the scope (Scope).
- getScope() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Gets the scope (Scope).
- getScratchFile() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the scratch file for this document.
- getScratchFile() - Method in class org.apache.pdfbox.cos.COSStream
-
This will get the scratch file associated with this stream.
- getScratchFile() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get the scratch file associated with this stream.
- getSecondCOSObject() - Method in interface org.apache.pdfbox.pdmodel.common.DualCOSObjectable
-
Convert this standard java object to a COS object.
- getSecondCOSObject() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
Convert this standard java object to a COS object.
- getSecurityHandler() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
- getSecurityHandler(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
-
Get the security handler for the protection policy.
- getSecurityHandler(String) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandlersManager
-
Retrieve the appropriate SecurityHandler for a the given filter name.
- getSecurityHandler() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Get the security handler that is used for document encryption.
- getSeparateByBeads() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will tell if the text stripper should separate by beads.
- getSetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the SetFf entry of the cos dictionary.
- getSetWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the SetF entry of the cos dictionary.
- getShading() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will get the shading resources for this pattern.
- getShadingName() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
This will return the name of this particular shading dictionary
- getShadings() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of shadings.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.PDShading
-
This will return the ShadingType -- an integer between 1 and 7 that specifies the gradient type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
-
This will return the shading type.
- getShadingType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
-
This will return the shading type.
- getSignature() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will get the signature or null if there is none.
- getSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
Get the signature dictionary
- getSignatureDictionary() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- getSignatureInterface() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will return the signature interface.
- getSignDate() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getSignedContent(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Will return the signed content of the document.
- getSignedContent(byte[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Will return the signed content of the document.
- getSize() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the size of the embedded file.
- getSize() - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
The "Size" entry, which is the number of samples in
each input dimension of the sample table.
- getSMaskImage() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Returns a PDXObjectImage of the SMask image, if there is one.
- getSmoothness() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
get the value of the smoothness property.
- getSmoothnessTolerance() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the smothness tolerance.
- getSortByPosition() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will tell if the text stripper should sort the text tokens
before writing to the stream.
- getSpaceAfter() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the amount of extra space following the after edge of the BLSE in
the block-progression direction (SpaceAfter).
- getSpaceBefore() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the amount of extra space preceding the before edge of the BLSE in
the block-progression direction (SpaceBefore).
- getSpacingTolerance() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Get the current space width-based tolerance value that is being used
to estimate where spaces in text should be added.
- getSplitAtPage() - Method in class org.apache.pdfbox.util.Splitter
-
This will return how many pages each split document will contain.
- getStack() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
-
Returns the stack used by this execution context.
- getStandard14Names() - Static method in class org.apache.pdfbox.pdmodel.font.PDType1Font
-
This will get the names of the standard 14 fonts.
- getStandardEncoding() - Method in class org.apache.pdfbox.encoding.EncodingManager
-
This will get the standard encoding.
- getStandardFont() - Static method in class org.apache.pdfbox.pdmodel.font.FontManager
-
Get the standard font from the environment, usually Arial or Times New Roman.
- getStandardFont(String) - Static method in class org.apache.pdfbox.pdmodel.font.PDType1Font
-
A convenience method to get one of the standard 14 font from name.
- getStandardOutput() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get the standard output stream.
- getStandardStructureType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the standard structure type, the actual structure type is mapped
to in the role map.
- getStart() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Returns the start value for page numbering in this page range.
- getStartBookmark() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Get the bookmark where text extraction should start, inclusive.
- getStartColour() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Gets the colour for the start edge.
- getStartIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the distance from the start edge of the reference area to that of
the BLSE in the inline-progression direction (StartIndent).
- getStartPage() - Method in class org.apache.pdfbox.util.PageExtractor
-
Gets the first page number to be extracted.
- getStartPage() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This is the page that the text extraction will start on.
- getStartPage() - Method in class org.apache.pdfbox.util.Splitter
-
This will return the start page.
- getStartPointEndingStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will retrieve the line ending style for the start point,
possible values shown in the LE_ constants section.
- getStartXref() - Method in class org.apache.pdfbox.cos.COSDocument
-
Return the startXref Position of the parsed document.
- getStartxref() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get the current start xref.
- getState() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will retrieve the annotation state.
- getStateModel() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will retrieve the annotation state model.
- getStatus() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the status string to be displayed as the result of an
action.
- getStatusLabel() - Method in class org.apache.pdfbox.pdfviewer.ReaderBottomPanel
-
This method initializes status label.
- getStdCryptFilterDictionary() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Returns the standard crypt filter.
- getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the stemH for the font.
- getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the stemH for the font.
- getStemH() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the stemH for the font.
- getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the stemV for the font.
- getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the stemV for the font.
- getStemV() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the stemV for the font.
- getStencilColor() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Returns the non stroking colorstate to be used to create stencil makes images.
- getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Get the cos stream associated with this object.
- getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
This will get the stream.
- getStream() - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Get the cos stream associated with this object.
- getStream() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
This will return the underlying stream.
- getStreamCount() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get the number of streams in the array.
- getStreamFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Returns the name of the filter which is used for de/encrypting streams.
- getStreamTokens() - Method in class org.apache.pdfbox.cos.COSStream
-
This will get all the tokens in the stream.
- getStreamTokens() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get all the tokens in the stream.
- getString(int) - Method in class org.apache.pdfbox.cos.COSArray
-
Get the value of the array as a string.
- getString(int, String) - Method in class org.apache.pdfbox.cos.COSArray
-
Get an entry in the array that is expected to be a COSName.
- getString(String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getString(COSName) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getString(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getString(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string.
- getString() - Method in class org.apache.pdfbox.cos.COSString
-
This will get the string that this object wraps.
- getString(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Gets a string attribute value.
- getStringFilterName() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Returns the name of the filter which is used for de/encrypting strings.
- getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the width of this string for this font.
- getStringWidth(String) - Method in class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
This will get the width of this string for this font.
- getStroke() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
This will return the current stroke.
- getStrokeJavaComposite() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
- getStrokingAlpaConstant() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the stroking alpha constant.
- getStrokingColor() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Returns the stroking color state.
- getStrokingOverprintControl() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint control.
- getStructureElement() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the structure element of this node.
- getStructureTreeRoot() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the document's structure tree root.
- getStructureType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the structure type (S).
- getStyle() - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Returns the numbering style for this page range.
- getStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
This will retrieve the border effect, see the STYLE_* constants for valid
values.
- getStyle() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will retrieve the border style, see the STYLE_* constants for valid
values.
- getSubFilter() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Get the name of the subfilter.
- getSubFilter() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- getSubject() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Get the description of the annotation.
- getSubject() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will retrieve the short description of the subject of the annotation.
- getSubject() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the subject of the document.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Get the subtype(mimetype) for the embedded file.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
-
Gets the subtype (Subtype).
- getSubType() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will get the subtype of font, Type1, Type3, ...
- getSubType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will get the type of action that the actions dictionary describes.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will retrieve the subtype of the annotation.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will retrieve the sub type (and hence appearance, AP taking precedence)
For this annotation.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
This will retrieve the sub type (and hence appearance, AP taking precedence)
For this annotation.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
returns the subtype of the external data dictionary.
- getSubtype() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
returns the subtype of the measure dictionary.
- getSuffix() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
This will get the suffix for this image type, jpg/png.
- getSummary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Gets the summary of the table???s purpose and structure.
- getSummary() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Gets the summary of the table???s purpose and structure.
- getSuppressDuplicateOverlappingText() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
- getTag() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Gets the tag.
- getTarget() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will get the target frame in the browser to open this document.
- getTBorderStyle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the style of the border drawn on each edge of a table cell
(TBorderStyle).
- getTemplateReference() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
This is the template reference.
- getTemplates() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
This will get a list of FDFTemplage objects that describe the named pages
that serve as templates.
- getTerminator() - Method in class org.apache.pdfbox.io.ASCII85OutputStream
-
This will get the terminating character.
- getText(PDDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will return the text of a document.
- getText(COSDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Deprecated.
- getTextAlign() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the alignment, in the inline-progression direction, of text and
other content within lines of the BLSE (TextAlign).
- getTextColor() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the text color of this node.
- getTextDecorationColor() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the colour to be used for drawing text decorations
(TextDecorationColor).
- getTextDecorationThickness() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the thickness of each line drawn as part of the text decoration
(TextDecorationThickness).
- getTextDecorationType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the type of text decoration (TextDecorationType).
- getTextForRegion(String) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
-
Get the text for the region, this should be called after extractRegions().
- getTextIndent() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the additional distance in the inline-progression direction from the
start edge of the BLSE, as specified by StartIndent, to that of the first
line of text (TextIndent).
- getTextKnockoutFlag() - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the text knockout flag.
- getTextLineMatrix() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getTextMatrix() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getTextPos() - Method in class org.apache.pdfbox.util.TextPosition
-
Return the Matrix textPos stored in this object.
- getTextPosition() - Method in class org.apache.pdfbox.util.PositionWrapper
-
Returns the underlying TextPosition object.
- getTextState() - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will get the graphics text state.
- getThousandsSeparator() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the text to be used between orders of thousands in display of numerical values.
- getThread() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
This will get the thread that this bead is part of.
- getThreadBeads() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will get a list of PDThreadBead objects, which are article threads in the
document.
- getThreadInfo() - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Get info about the thread, or null if there is nothing.
- getThreads() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the list threads for this pdf document.
- getTilingType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the tiling type.
- getTintTransform() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will get the tint transform function.
- getTintTransform() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will get the tint transform function.
- getTitle() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Returns the title (T).
- getTitle() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Get the annotation title.
- getTitle() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Get the title of this node.
- getTitle() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the title of the document.
- getTitle() - Method in class org.apache.pdfbox.util.PDFText2HTML
-
This method will attempt to guess the title of the document using
either the document properties or the first lines of text.
- getTitlePopup() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Retrieve the string used as the title of the popup window shown when open
and active (by convention this identifies who added the annotation).
- getTokenIterator() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
-
This will get an iterator which can be used to parse the stream
one token after the other.
- getTokens() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
-
This will get the tokens that were parsed from the stream.
- getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Get the top y coordinate.
- getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
-
Get the top y coordinate.
- getTop() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Get the top y coordinate.
- getTotalCharCnt() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Get the total number of characters in the doc
(including ones that could not be mapped).
- getToUnicode() - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will get the ToUnicode object.
- getTPadding() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the offset to account for the separation between the table cell???s
content rectangle and the surrounding border (TPadding).
- getTrailer() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the document trailer.
- getTrailer() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Gets the resolved trailer.
- getTranslatingInstance(float, float) - Static method in class org.apache.pdfbox.util.Matrix
-
Convenience method to create a translating instance.
- getTransparency() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.AxialShadingPaint
- getTransparency() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.RadialShadingPaint
- getTrapped() - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will get the trapped value for the document.
- getTreeCellRendererComponent(JTree, Object, boolean, boolean, boolean, int, boolean) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeCellRenderer
- getTrimBox() - Method in class org.apache.pdfbox.pdmodel.PDPage
-
A rectangle, expressed in default user space units, defining
the intended dimensions of the finished page after trimming.
- getType() - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
Get the type of this object, should always return "ObjStm".
- getType() - Method in class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
-
Gets the type.
- getType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Returns the type.
- getType() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
-
Gets the type (Type).
- getType() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will always return "Font" for fonts.
- getType() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will return the paint type.
- getType() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will return the type.
- getType() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will get the type of PDF object that the actions dictionary describes.
- getType() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
returns the type of the external data dictionary.
- getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
This will return the type of the measure dictionary.
- getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the type of the number format dictionary.
- getType() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
Returns the type of the viewport dictionary.
- getU() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the mouse button
is released inside the annotation's active area.
- getUnfilteredStream() - Method in class org.apache.pdfbox.cos.COSStream
-
This will get the logical content stream with none of the filters.
- getUnfilteredStream() - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
This will get the logical content stream with none of the filters.
- getUnits() - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will return the label for the units.
- getUpperLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Get the highest value for a key in the name map.
- getUpperLimit() - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Get the highest value for a key in the name map.
- getUpperRightX() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the upper right x coordinate.
- getUpperRightY() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the upper right y coordinate.
- getURI() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will get the uniform resource identifier to resolve, encoded in 7-bit ASCII.
- getURI() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Document level information in the URI.
- getUserKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will get the U entry in the standard encryption dictionary.
- getUserKey() - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will get the U entry in the standard encryption dictionary.
- getUserPassword(byte[], byte[], int, long) - Method in class org.apache.pdfbox.encryption.PDFEncryption
-
Deprecated.
This will get the user password from the owner password and the documents o value.
- getUserPassword() - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Getter of the property userPassword.
- getUserPassword(byte[], byte[], int, long) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Get the user password based on the owner password.
- getUserPasswordForEncryption() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Deprecated.
Do not rely on this method anymore.
- getV() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will get a JavaScript action to be performed
when the field's value is changed.
- getValidCharCnt() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Get the total number of valid characters in the doc
that could be decoded in processEncodedText().
- getValue() - Method in class org.apache.pdfbox.cos.COSBoolean
-
This will get the value that this object wraps.
- getValue() - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
-
This will get the value for this entry.
- getValue() - Method in class org.apache.pdfbox.pdfviewer.MapEntry
-
This will get the value for this entry.
- getValue(int, int) - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
-
This will get a matrix value at some point.
- getValue(String) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
The name to retrieve.
- getValue(Integer) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Returns the value corresponding to an index in the number tree.
- getValue() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Returns the property value.
- getValue() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the value for the field.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
-
getValue gets the fields value to as a string.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
getValue gets the fields value to as a string.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
-
getValue gets the fields value to as a string.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
-
getValue gets the fields value to as a string.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
-
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
Deprecated.
use getSignature() instead
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
-
getValue gets the fields value to as a string.
- getValue() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
getValue gets the fields value to as a string.
- getValue(int, int) - Method in class org.apache.pdfbox.util.Matrix
-
This will get a matrix value at some point.
- getValueAsObject() - Method in class org.apache.pdfbox.cos.COSBoolean
-
This will get the value that this object wraps.
- getValues() - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will get all of the values for the dictionary.
- getValues() - Method in class org.apache.pdfbox.util.Matrix
-
Return a single dimension array of all values in the matrix.
- getValuesAsDouble() - Method in class org.apache.pdfbox.util.Matrix
-
Return a single dimension array of all values in the matrix.
- getVersion() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will get the version of this PDF document.
- getVersion() - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will return the V entry of the encryption dictionary.
- getVersion() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will get the version that was specified in the catalog dictionary.
- getVersion() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Returns the PDF specification version this document conforms to.
- getVersion() - Static method in class org.apache.pdfbox.Version
-
Get the version of PDFBox or unknown if it is not known.
- getVerticesPerRow() - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
The vertices per row of this shading.
- getViewArea() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the ViewArea preference.
- getViewClip() - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Get the ViewClip preference.
- getViewerPreferences() - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Get the viewer preferences associated with this document or null if they
do not exist.
- getVisualSignature() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Get the visual signature.
- getWC() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will get a JavaScript action to be performed
before closing a document.
- getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will return the whitepoint tristimulus.
- getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will return the whitepoint tristimulus.
- getWhitepoint() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will return the whitepoint tristimulus.
- getWidget() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will get the single associated widget that is part of this field.
- getWidgetFieldFlags() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the F entry of the cos dictionary.
- getWidth() - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will get the width of this rectangle as calculated by
upperRightX - lowerLeftX.
- getWidth() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the width of the element???s content rectangle in the
inline-progression direction (Width).
- getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- getWidth() - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Get the width of the image.
- getWidth() - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will retrieve the border width in points, 0 = no border.
- getWidth() - Method in class org.apache.pdfbox.util.ImageParameters
-
The width of this image.
- getWidth() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the width of the string when page rotation adjusted coordinates are used.
- getWidthDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the width of the string when text direction adjusted coordinates are used.
- getWidthOfSpace() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the width of a space character.
- getWidths() - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
The widths of the characters.
- getWinLaunchParams() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will get a dictionary containing Windows-specific launch parameters.
- getWordSeparator() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will get the word separator.
- getWordSpacing() - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Get the value of the wordSpacing.
- getWordSpacing() - Method in class org.apache.pdfbox.util.TextPosition
-
Deprecated.
- getWP() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will get a JavaScript action to be performed
before printing a document.
- getWritingMode() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Gets the writing mode (WritingMode).
- getWS() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will get a JavaScript action to be performed
before saving a document.
- getX() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will get the x value of the tristimulus.
- getX() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will get an action to be performed when the cursor
exits the annotation's active area.
- getX() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the page rotation adjusted x position of the character.
- getX509() - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
-
Returns the X509 certificate of the recipient.
- getXDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the text direction adjusted x position of the character.
- getXFA() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Get the XFA resource, the XFA resource is only used for PDF 1.5+ forms.
- getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will get the x height for the font.
- getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will get the x height for the font.
- getXHeight() - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will get the x height for the font.
- getXObjects() - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will get the map of PDXObjects that are in the resource dictionary.
- getXObjects() - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- getXPosition() - Method in class org.apache.pdfbox.util.Matrix
-
Get the x position in the matrix.
- getXRefEntries() - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will get the xref entries.
- getXRefRanges(List<COSWriterXRefEntry>) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
check the xref entries and write out the ranges.
- getXrefTable() - Method in class org.apache.pdfbox.cos.COSDocument
-
Returns the xrefTable which is a mapping of ObjectKeys
to byte offsets in the file.
- getXrefTable() - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Gets the resolved xref table.
- getXScale() - Method in class org.apache.pdfbox.util.Matrix
-
Get the xscaling factor of this matrix.
- getXScale() - Method in class org.apache.pdfbox.util.TextPosition
-
- getXStep() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the XStep value.
- getY() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will get the y value of the tristimulus.
- getY() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the y position of the text, adjusted so that 0,0 is upper left and
it is adjusted based on the page rotation.
- getYDirAdj() - Method in class org.apache.pdfbox.util.TextPosition
-
This will get the y position of the text, adjusted so that 0,0 is upper left and
it is adjusted based on the text direction.
- getYPosition() - Method in class org.apache.pdfbox.util.Matrix
-
Get the y position.
- getYScale() - Method in class org.apache.pdfbox.util.Matrix
-
Get the y scaling factor of this matrix.
- getYScale() - Method in class org.apache.pdfbox.util.TextPosition
-
- getYStep() - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will return the YStep value.
- getZ() - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will get the z value of the tristimulus.
- getZoom() - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Get the zoom value.
- GLYPH_ORIENTATION_VERTICAL_180_DEGREES - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
GlyphOrientationVertical: 180??
- 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??
- GRestore - Class in org.apache.pdfbox.util.operator
-
- GRestore() - Constructor for class org.apache.pdfbox.util.operator.GRestore
-
- growToSize(int) - Method in class org.apache.pdfbox.cos.COSArray
-
This will add null values until the size of the array is at least
as large as the parameter.
- growToSize(int, COSBase) - Method in class org.apache.pdfbox.cos.COSArray
-
This will add the object until the size of the array is at least
as large as the parameter.
- GSave - Class in org.apache.pdfbox.util.operator
-
- GSave() - Constructor for class org.apache.pdfbox.util.operator.GSave
-
- GUIDELINE_STYLE_DASHED - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Style for guideline.
- GUIDELINE_STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Style for guideline.
- P - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- P - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
-
P
- PackedBitArray - Class in org.apache.pdfbox.io.ccitt
-
Represents an array of bits packed in a byte array of fixed size.
- PackedBitArray(int) - Constructor for class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Constructs a new bit array.
- Paeth - Class in org.apache.pdfbox.pdmodel.graphics.predictor
-
From http://www.w3.org/TR/PNG-Filters.html: The Paeth filter computes a
simple linear function of the three neighboring pixels (left, above, upper
left), then chooses as predictor the neighboring pixel closest to the
computed value.
- Paeth() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Paeth
-
- paethPredictor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Paeth
-
The paeth predictor function.
- PAGE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- page - Variable in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Current page to be rendered.
- PAGE_LABELS - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PAGE_LAYOUT - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PAGE_LAYOUT_ONE_COLUMN - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display the pages in one column.
- PAGE_LAYOUT_SINGLE_PAGE - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display one page at a time.
- PAGE_LAYOUT_TWO_COLUMN_LEFT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display the pages in two columns, with odd numbered pagse on the left.
- PAGE_LAYOUT_TWO_COLUMN_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display the pages in two columns, with odd numbered pagse on the right.
- PAGE_LAYOUT_TWO_PAGE_LEFT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display the pages two at a time, with odd-numbered pages on the left.
- PAGE_LAYOUT_TWO_PAGE_RIGHT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Display the pages two at a time, with odd-numbered pages on the right.
- PAGE_MODE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PAGE_MODE_FULL_SCREEN - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Full screen mode with no menu bar, window controls.
- PAGE_MODE_USE_ATTACHMENTS - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Attachments panel is visible.
- PAGE_MODE_USE_NONE - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Page mode where neither the outline nor the thumbnails
are displayed.
- PAGE_MODE_USE_OPTIONAL_CONTENT - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Optional content group panel is visible when opened.
- PAGE_MODE_USE_OUTLINES - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Show bookmarks when pdf is opened.
- PAGE_MODE_USE_THUMBS - Static variable in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Show thumbnails when pdf is opened.
- PAGE_SIZE_A0 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A0 Paper.
- PAGE_SIZE_A1 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A1 Paper.
- PAGE_SIZE_A2 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A2 Paper.
- PAGE_SIZE_A3 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A3 Paper.
- PAGE_SIZE_A4 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A4 Paper.
- PAGE_SIZE_A5 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A5 Paper.
- PAGE_SIZE_A6 - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of A6 Paper.
- PAGE_SIZE_LETTER - Static variable in class org.apache.pdfbox.pdmodel.PDPage
-
A page size of LETTER or 8.5x11.
- PageDrawer - Class in org.apache.pdfbox.pdfviewer
-
This will paint a page in a PDF document to a graphics context.
- PageDrawer() - Constructor for class org.apache.pdfbox.pdfviewer.PageDrawer
-
Default constructor, loads properties from file.
- PageExtractor - Class in org.apache.pdfbox.util
-
This class will extract one or more sequential pages and create a new document.
- PageExtractor(PDDocument) - Constructor for class org.apache.pdfbox.util.PageExtractor
-
Creates a new instance of PageExtractor
- PageExtractor(PDDocument, int, int) - Constructor for class org.apache.pdfbox.util.PageExtractor
-
Creates a new instance of PageExtractor
- pageNumber - Variable in class org.apache.pdfbox.util.Splitter
-
The current page number that we are processing, zero based.
- PAGES - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- pageSize - Variable in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Size of the page.
- PageWrapper - Class in org.apache.pdfbox.pdfviewer
-
A class to handle some prettyness around a single PDF page.
- PageWrapper(PDFReader) - Constructor for class org.apache.pdfbox.pdfviewer.PageWrapper
-
Constructor.
- paint(Graphics) - Method in class org.apache.pdfbox.pdfviewer.PDFPagePanel
- PAINT_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- params - Variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
The params dictionary.
- PARENT - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PARENT_TREE_NEXT_KEY - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- parse() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
This will parse the stream and populate the COSDocument object.
- parse() - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
This will parse the stream and populate the COSDocument object.
- parse() - Method in class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
-
This will parse the tokens in the stream.
- parse() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will parse the stream and populate the COSDocument object.
- parse() - Method in class org.apache.pdfbox.pdfparser.PDFStreamParser
-
This will parse the tokens in the stream.
- parse() - Method in class org.apache.pdfbox.pdfparser.PDFXrefStreamParser
-
Parses through the unfiltered stream and populates the xrefTable HashMap.
- parse() - Method in class org.apache.pdfbox.pdfparser.VisualSignatureParser
- 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.
- parseBoolean() - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will parse a boolean object from the stream.
- parseCmap(String, InputStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
- parseCOSArray() - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will parse a PDF array object.
- parseCOSDictionary() - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will parse a PDF dictionary.
- parseCOSName() - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will parse a PDF name from the stream.
- parseCOSStream(COSDictionary, RandomAccess) - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will read a COSStream from the input stream.
- parseCOSStream(COSDictionary, RandomAccess) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
This will read a COSStream from the input stream using length attribute
within dictionary.
- parseCOSString() - 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.
- parseInt(String) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
-
Parses a value of type "int".
- parseNumber(String) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
- 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
-
- Parser.AbstractSyntaxHandler() - Constructor for class org.apache.pdfbox.pdmodel.common.function.type4.Parser.AbstractSyntaxHandler
-
- Parser.SyntaxHandler - Interface in org.apache.pdfbox.pdmodel.common.function.type4
-
This interface defines all possible syntactic elements of a Type 4 function.
- parseReal(String) - Static method in class org.apache.pdfbox.pdmodel.common.function.type4.InstructionSequenceBuilder
-
Parses a value of type "real".
- parseStartXref() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will parse the startxref section from the stream.
- parseTrailer() - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will parse the trailer from the stream and add it to the state.
- parseTrailerInformation() - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
- parseXrefStream(COSStream, long) - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
Fills XRefTrailerResolver with data of given stream.
- parseXrefTable(long) - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This will parse the xref table from the stream and add it to the state
The XrefTable contents are ignored.
- PART - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
-
Part
- PATTERN - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PATTERN_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PDAcroForm - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This class represents the acroform of a PDF document.
- PDAcroForm(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Constructor.
- PDAcroForm(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Constructor.
- PDAction - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents an action that can be executed in a PDF document.
- PDAction() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
Default constructor.
- PDAction(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
Constructor.
- PDActionFactory - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This class will take a dictionary and determine which type of action to create.
- PDActionGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents a go-to action that can be executed in a PDF document.
- PDActionGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
-
Default constructor.
- PDActionGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
-
Constructor.
- PDActionJavaScript - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents a JavaScript action.
- PDActionJavaScript() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
Constructor #1.
- PDActionJavaScript(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
Constructor.
- PDActionJavaScript(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
Constructor #2.
- PDActionLaunch - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents a launch action that can be executed in a PDF document.
- PDActionLaunch() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
Default constructor.
- PDActionLaunch(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
Constructor.
- PDActionRemoteGoTo - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents a remote go-to action that can be executed in a PDF document.
- PDActionRemoteGoTo() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
Default constructor.
- PDActionRemoteGoTo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
Constructor.
- PDActionURI - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This represents a URI action that can be executed in a PDF document.
- PDActionURI() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
Default constructor.
- PDActionURI(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
Constructor.
- PDAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This represents a dictionary of actions that occur due to events.
- PDAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Default constructor.
- PDAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Constructor.
- PDAnnotation - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents a PDF annotation.
- PDAnnotation() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Constructor.
- PDAnnotation(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Constructor.
- PDAnnotationAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This class represents an annotation's dictionary of actions
that occur due to events.
- PDAnnotationAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
Default constructor.
- PDAnnotationAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
Constructor.
- PDAnnotationFileAttachment - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a file attachement.
- PDAnnotationFileAttachment() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
Constructor.
- PDAnnotationFileAttachment(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
Creates a Link annotation from a COSDictionary, expected to be
a correct object definition.
- PDAnnotationLine - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a line annotation.
- PDAnnotationLine() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
Constructor.
- PDAnnotationLine(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
- PDAnnotationLink - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a link annotation.
- PDAnnotationLink() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Constructor.
- PDAnnotationLink(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Creates a Link annotation from a COSDictionary, expected to be
a correct object definition.
- PDAnnotationMarkup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents the additonal fields of a Markup type Annotation.
- PDAnnotationMarkup() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constructor.
- PDAnnotationMarkup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constructor.
- PDAnnotationPopup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a popup annotation.
- PDAnnotationPopup() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
Constructor.
- PDAnnotationPopup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
Creates a popup annotation from a COSDictionary, expected to be a correct
object definition.
- PDAnnotationRubberStamp - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a rubber stamp annotation.
- PDAnnotationRubberStamp() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
Constructor.
- PDAnnotationRubberStamp(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
Creates a Rubber Stamp annotation from a COSDictionary, expected to be
a correct object definition.
- PDAnnotationSquareCircle - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a rectangular or eliptical annotation
Introduced in PDF 1.3 specification .
- PDAnnotationSquareCircle(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
Creates a Circle or Square annotation of the specified sub type.
- PDAnnotationSquareCircle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
Creates a Line annotation from a COSDictionary, expected to be a correct
object definition.
- PDAnnotationText - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a text annotation.
- PDAnnotationText() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
Constructor.
- PDAnnotationText(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
Creates a Text annotation from a COSDictionary, expected to be a correct
object definition.
- PDAnnotationTextMarkup - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the abstract class that represents a text markup annotation
Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.
- PDAnnotationTextMarkup(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
Creates a TextMarkup annotation of the specified sub type.
- PDAnnotationTextMarkup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
Creates a TextMarkup annotation from a COSDictionary, expected to be a
correct object definition.
- PDAnnotationUnknown - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents an arbitary Unknown Annotation type.
- PDAnnotationUnknown(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown
-
Creates an arbitary annotation from a COSDictionary, expected to be
a correct object definition for some sort of annotation.
- PDAnnotationWidget - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This is the class that represents a widget.
- PDAnnotationWidget() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Constructor.
- PDAnnotationWidget(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Creates a PDWidget from a COSDictionary, expected to be
a correct object definition for a field in PDF.
- PDAppearance - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This one took me a while, but i'm proud to say that it handles
the appearance of a textbox.
- PDAppearance(PDAcroForm, PDVariableText) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDAppearance
-
Constructs a COSAppearnce from the given field.
- PDAppearanceCharacteristicsDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents an appearance characteristics dictionary.
- PDAppearanceCharacteristicsDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
Constructor.
- PDAppearanceDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents a PDF /AP entry the appearance dictionary.
- PDAppearanceDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
Constructor.
- PDAppearanceDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
Constructor.
- PDAppearanceStream - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents an appearance for an annotation.
- PDAppearanceStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
Constructor.
- PDArtifactMarkedContent - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
An artifact marked content.
- PDArtifactMarkedContent(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDArtifactMarkedContent
-
- PDAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
An attribute object.
- PDAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Default constructor.
- PDAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Creates a new attribute object with a given dictionary.
- PDBorderEffectDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents a PDF /BE entry the border effect dictionary.
- PDBorderEffectDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
Constructor.
- PDBorderEffectDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
Constructor.
- PDBorderStyleDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents a PDF /BS entry the border style dictionary.
- PDBorderStyleDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constructor.
- PDBorderStyleDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constructor.
- PDBoxStyle - Class in org.apache.pdfbox.pdmodel.documentinterchange.prepress
-
The Box Style specifies visual characteristics for displaying box areas.
- PDBoxStyle() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Default Constructor.
- PDBoxStyle(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Constructor for an existing BoxStyle element.
- PDCalGray - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Cal Gray color space.
- PDCalGray() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
Constructor.
- PDCalGray(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
Constructor with array.
- PDCalRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Cal RGB color space.
- PDCalRGB() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
Constructor.
- PDCalRGB(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
Constructor with array.
- PDCcitt - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
An image class for CCITT Fax.
- PDCcitt(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
-
Standard constructor.
- PDCcitt(PDDocument, RandomAccess) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDCcitt
-
Construct from a tiff file.
- PDCheckbox - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a checkbox.
- PDCheckbox(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
-
- PDChoiceButton - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This holds common functionality for check boxes and radio buttons.
- PDChoiceButton(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
-
- PDChoiceField - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a choicefield.
- PDChoiceField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
-
- PDCIDFont - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation for the CIDFontType0/CIDFontType2 Fonts.
- PDCIDFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
Constructor.
- PDCIDFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
Constructor.
- PDCIDFontType0Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the CIDFontType0 Font.
- PDCIDFontType0Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
-
Constructor.
- PDCIDFontType0Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType0Font
-
Constructor.
- PDCIDFontType2Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the CIDFontType2 Font.
- PDCIDFontType2Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
-
Constructor.
- PDCIDFontType2Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDCIDFontType2Font
-
Constructor.
- PDColorSpace - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a color space in a pdf document.
- PDColorSpace() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorSpace
-
- PDColorSpaceFactory - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a color space in a pdf document.
- PDColorState - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a color space and the color value for that colorspace.
- PDColorState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
Default constructor.
- PDColorState(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
Constructor with an existing color set.
- PDComplexFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
-
This represents a file specification.
- PDComplexFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Default Constructor.
- PDComplexFileSpecification(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Constructor.
- PDCryptFilterDictionary - Class in org.apache.pdfbox.pdmodel.encryption
-
This class is a specialized view of the crypt filter dictionary of a PDF document.
- PDCryptFilterDictionary() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
creates a new empty crypt filter dictionary.
- PDCryptFilterDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
creates a new crypt filter dictionary from the low level dictionary provided.
- PDDefaultAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A default attribute object.
- PDDefaultAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Default constructor.
- PDDefaultAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Creates a default attribute object with a given dictionary.
- PDDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination in a PDF document.
- PDDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDDestination
-
- PDDestinationNameTreeNode - Class in org.apache.pdfbox.pdmodel
-
This class holds all of the name trees that are available at the document level.
- PDDestinationNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
-
Constructor.
- PDDestinationNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDestinationNameTreeNode
-
Constructor.
- PDDestinationOrAction - Interface in org.apache.pdfbox.pdmodel.common
-
This is an interface used for some elements such as the document
OpenAction that can be either a Destination or an Action.
- PDDeviceCMYK - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a CMYK color space.
- PDDeviceGray - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Gray color space.
- PDDeviceGray() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceGray
-
- PDDeviceN - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a DeviceN color space.
- PDDeviceN() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
Constructor.
- PDDeviceN(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
Constructor.
- PDDeviceNAttributes - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents attributes for a DeviceN color space.
- PDDeviceNAttributes() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
-
Constructor.
- PDDeviceNAttributes(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
-
Constructor.
- PDDeviceRGB - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents an RGB color space.
- PDDictionaryWrapper - Class in org.apache.pdfbox.pdmodel.common
-
A wrapper for a COS dictionary.
- PDDictionaryWrapper() - Constructor for class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
Default constructor
- PDDictionaryWrapper(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper
-
Creates a new instance with a given COS dictionary.
- PDDocument - Class in org.apache.pdfbox.pdmodel
-
This is the in-memory representation of the PDF document.
- PDDocument() - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
-
Constructor, creates a new PDF Document with no pages.
- PDDocument(COSDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDDocument
-
Constructor that uses an existing document.
- PDDocumentCatalog - Class in org.apache.pdfbox.pdmodel
-
This class represents the acroform of a PDF document.
- PDDocumentCatalog(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Constructor.
- PDDocumentCatalog(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Constructor.
- PDDocumentCatalogAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This class represents a document catalog's dictionary of actions
that occur due to events.
- PDDocumentCatalogAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
Default constructor.
- PDDocumentCatalogAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
Constructor.
- PDDocumentInformation - Class in org.apache.pdfbox.pdmodel
-
This is the document metadata.
- PDDocumentInformation() - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
Default Constructor.
- PDDocumentInformation(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
Constructor that is used for a preexisting dictionary.
- PDDocumentNameDictionary - Class in org.apache.pdfbox.pdmodel
-
This class holds all of the name trees that are available at the document level.
- PDDocumentNameDictionary(PDDocumentCatalog) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Constructor.
- PDDocumentNameDictionary(PDDocumentCatalog, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Constructor.
- PDDocumentOutline - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
-
This represents an outline in a pdf document.
- PDDocumentOutline() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
-
Default Constructor.
- PDDocumentOutline(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDDocumentOutline
-
Constructor for an existing document outline.
- PDEmbeddedFile - Class in org.apache.pdfbox.pdmodel.common.filespecification
-
This represents an embedded file in a file specification.
- PDEmbeddedFile(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Constructor.
- PDEmbeddedFile(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Constructor.
- PDEmbeddedFile(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Constructor.
- PDEmbeddedFile(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Constructor.
- PDEmbeddedFilesNameTreeNode - Class in org.apache.pdfbox.pdmodel
-
This class holds all of the name trees that are available at the document level.
- PDEmbeddedFilesNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
-
Constructor.
- PDEmbeddedFilesNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDEmbeddedFilesNameTreeNode
-
Constructor.
- PDEncryptionDictionary - Class in org.apache.pdfbox.pdmodel.encryption
-
This class is a specialized view of the encryption dictionary of a PDF document.
- PDEncryptionDictionary() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
creates a new empty encryption dictionary.
- PDEncryptionDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
creates a new encryption dictionary from the low level dictionary provided.
- PDEncryptionManager - Class in org.apache.pdfbox.pdmodel.encryption
-
Deprecated.
Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
- PDExportFormatAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
An Export Format attribute object.
- PDExportFormatAttributeObject(String) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Default constructor.
- PDExportFormatAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Creates a new ExportFormat attribute object with a given dictionary.
- PDExtendedGraphicsState - Class in org.apache.pdfbox.pdmodel.graphics
-
This class represents the graphics state dictionary that is stored in the PDF document.
- PDExtendedGraphicsState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
Default constructor, creates blank graphics state.
- PDExtendedGraphicsState(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
Create a graphics state from an existing dictionary.
- PDExternalDataDictionary - Class in org.apache.pdfbox.pdmodel.interactive.annotation
-
This class represents an external data dictionary.
- PDExternalDataDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
Constructor.
- PDExternalDataDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
Constructor.
- PDF_DOC_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PDFBox - Class in org.apache.pdfbox
-
Simple wrapper around all the command line utilities included in PDFBox.
- PDFBox() - Constructor for class org.apache.pdfbox.PDFBox
-
- PDFCloneUtility - Class in org.apache.pdfbox.util
-
Utility class used to clone PDF objects.
- PDFCloneUtility(PDDocument) - Constructor for class org.apache.pdfbox.util.PDFCloneUtility
-
Creates a new instance for the given target document.
- PDFDebugger - Class in org.apache.pdfbox
-
- PDFDebugger() - Constructor for class org.apache.pdfbox.PDFDebugger
-
Constructor.
- PdfDecompressor - Class in org.apache.pdfbox
-
This program will just take all of the stream objects in a PDF and dereference
them.
- PdfDecompressor() - Constructor for class org.apache.pdfbox.PdfDecompressor
-
- PdfDocEncoding - Class in org.apache.pdfbox.encoding
-
This is an interface to a text encoder.
- PdfDocEncoding() - Constructor for class org.apache.pdfbox.encoding.PdfDocEncoding
-
Constructor.
- pdfDocument - Variable in class org.apache.pdfbox.util.Splitter
-
The source PDF document.
- PDFEncryption - Class in org.apache.pdfbox.encryption
-
Deprecated.
use the new security layer instead
- PDFEncryption() - Constructor for class org.apache.pdfbox.encryption.PDFEncryption
-
Deprecated.
- PDFHighlighter - Class in org.apache.pdfbox.util
-
Highlighting of words in a PDF document with an XML file.
- PDFHighlighter() - Constructor for class org.apache.pdfbox.util.PDFHighlighter
-
Default constructor.
- PDField - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This is the superclass for a Field element in a PDF.
- PDField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Constructor.
- PDField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Creates a COSField from a COSDictionary, expected to be
a correct object definition for a field in PDF.
- PDFieldFactory - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This is the Factory for creating and returning the correct
field elements.
- PDFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
-
This represents a file specification.
- PDFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
-
- PDFImageWriter - Class in org.apache.pdfbox.util
-
This class will take a PDF document and strip out all of the text and ignore the
formatting and such.
- PDFImageWriter() - Constructor for class org.apache.pdfbox.util.PDFImageWriter
-
Instantiate a new PDFImageWriter object.
- PDFImageWriter(Properties) - Constructor for class org.apache.pdfbox.util.PDFImageWriter
-
Instantiate a new PDFImageWriter object.
- PDFMarkedContentExtractor - Class in org.apache.pdfbox.util
-
This is an stream engine to extract the marked content of a pdf.
- PDFMarkedContentExtractor() - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
-
Instantiate a new PDFTextStripper object.
- PDFMarkedContentExtractor(Properties) - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
-
Instantiate a new PDFTextStripper object.
- PDFMarkedContentExtractor(String) - Constructor for class org.apache.pdfbox.util.PDFMarkedContentExtractor
-
Instantiate a new PDFTextStripper object.
- PDFMerger - Class in org.apache.pdfbox
-
This is the main program that will take a list of pdf documents and merge them,
saving the result in a new document.
- PDFMergerUtility - Class in org.apache.pdfbox.util
-
This class will take a list of pdf documents and merge them, saving the result
in a new document.
- PDFMergerUtility() - Constructor for class org.apache.pdfbox.util.PDFMergerUtility
-
Instantiate a new PDFMergerUtility.
- PDFObjectStreamParser - Class in org.apache.pdfbox.pdfparser
-
This will parse a PDF 1.5 object stream and extract all of the objects from the stream.
- PDFObjectStreamParser(COSStream, COSDocument, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
-
Constructor.
- PDFObjectStreamParser(COSStream, COSDocument) - Constructor for class org.apache.pdfbox.pdfparser.PDFObjectStreamParser
-
Constructor.
- PDFont - Class in org.apache.pdfbox.pdmodel.font
-
This is the base class for all PDF fonts.
- PDFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFont
-
Constructor.
- PDFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFont
-
Constructor.
- PDFontDescriptor - Class in org.apache.pdfbox.pdmodel.font
-
This class represents an interface to the font description.
- PDFontDescriptor() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
- PDFontDescriptorAFM - Class in org.apache.pdfbox.pdmodel.font
-
This class represents the font descriptor when the font information
is coming from an AFM file.
- PDFontDescriptorAFM(FontMetric) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
Constructor.
- PDFontDescriptorDictionary - Class in org.apache.pdfbox.pdmodel.font
-
This class represents an implementation to the font descriptor that gets its
information from a COS Dictionary.
- PDFontDescriptorDictionary() - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Constructor.
- PDFontDescriptorDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Constructor.
- PDFontFactory - Class in org.apache.pdfbox.pdmodel.font
-
This will create the correct type of font based on information in the dictionary.
- PDFontSetting - Class in org.apache.pdfbox.pdmodel.graphics
-
This class represents a font setting used for the graphics state.
- PDFontSetting() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
Creates a blank font setting, font will be null, size will be 1.
- PDFontSetting(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
Constructs a font setting from an existing array.
- PDFOperator - Class in org.apache.pdfbox.util
-
This class represents an Operator in the content stream.
- PDFormFieldAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This class represents a form field's dictionary of actions
that occur due to events.
- PDFormFieldAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
Default constructor.
- PDFormFieldAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
Constructor.
- PDFourColours - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
An object for four colours.
- PDFourColours() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
- PDFourColours(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
- PDFPagePanel - Class in org.apache.pdfbox.pdfviewer
-
This is a simple JPanel that can be used to display a PDF page.
- PDFPagePanel() - Constructor for class org.apache.pdfbox.pdfviewer.PDFPagePanel
-
Constructor.
- PDFParser - Class in org.apache.pdfbox.pdfparser
-
This class will handle the parsing of the PDF document.
- PDFParser(InputStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
-
Constructor.
- PDFParser(InputStream, RandomAccess) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
-
Constructor to allow control over RandomAccessFile.
- PDFParser(InputStream, RandomAccess, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFParser
-
Constructor to allow control over RandomAccessFile.
- PDFReader - Class in org.apache.pdfbox
-
An application to read PDF documents.
- PDFReader() - Constructor for class org.apache.pdfbox.PDFReader
-
Constructor.
- pdfSource - Variable in class org.apache.pdfbox.pdfparser.BaseParser
-
This is the stream that will be read from.
- PDFSplit - Class in org.apache.pdfbox
-
This is the main program that will take a pdf document and split it into
a number of other documents.
- PDFStreamEngine - Class in org.apache.pdfbox.util
-
This class will run through a PDF content stream and execute certain operations
and provide a callback interface for clients that want to do things with the stream.
- PDFStreamEngine() - Constructor for class org.apache.pdfbox.util.PDFStreamEngine
-
Constructor.
- PDFStreamEngine(Properties) - Constructor for class org.apache.pdfbox.util.PDFStreamEngine
-
Constructor with engine properties.
- PDFStreamParser - Class in org.apache.pdfbox.pdfparser
-
This will parse a PDF byte stream and extract operands and such.
- PDFStreamParser(InputStream, RandomAccess, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
-
Constructor that takes a stream to parse.
- PDFStreamParser(InputStream, RandomAccess) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
-
Constructor that takes a stream to parse.
- PDFStreamParser(PDStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
-
Constructor.
- PDFStreamParser(COSStream, boolean) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
-
Constructor.
- PDFStreamParser(COSStream) - Constructor for class org.apache.pdfbox.pdfparser.PDFStreamParser
-
Constructor.
- PDFText2HTML - Class in org.apache.pdfbox.util
-
Wrap stripped text in simple HTML, trying to form HTML paragraphs.
- PDFText2HTML(String) - Constructor for class org.apache.pdfbox.util.PDFText2HTML
-
Constructor.
- PDFTextStripper - Class in org.apache.pdfbox.util
-
This class will take a pdf document and strip out all of the text and ignore the
formatting and such.
- PDFTextStripper() - Constructor for class org.apache.pdfbox.util.PDFTextStripper
-
Instantiate a new PDFTextStripper object.
- PDFTextStripper(Properties) - Constructor for class org.apache.pdfbox.util.PDFTextStripper
-
Instantiate a new PDFTextStripper object.
- PDFTextStripper(String) - Constructor for class org.apache.pdfbox.util.PDFTextStripper
-
Instantiate a new PDFTextStripper object.
- PDFTextStripperByArea - Class in org.apache.pdfbox.util
-
This will extract text from a specified region in the PDF.
- PDFTextStripperByArea() - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
-
Constructor.
- PDFTextStripperByArea(Properties) - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
-
Instantiate a new PDFTextStripperArea object.
- PDFTextStripperByArea(String) - Constructor for class org.apache.pdfbox.util.PDFTextStripperByArea
-
Instantiate a new PDFTextStripperArea object.
- PDFToImage - Class in org.apache.pdfbox
-
Convert a PDF document to an image.
- PDFTreeCellRenderer - Class in org.apache.pdfbox.pdfviewer
-
A class to render tree cells for the pdfviewer.
- PDFTreeCellRenderer() - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeCellRenderer
-
- PDFTreeModel - Class in org.apache.pdfbox.pdfviewer
-
A class to model a PDF document as a tree structure.
- PDFTreeModel() - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
constructor.
- PDFTreeModel(PDDocument) - Constructor for class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Constructor to take a document.
- PDFunction - Class in org.apache.pdfbox.pdmodel.common.function
-
This class represents a function in a PDF document.
- PDFunction(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
Constructor.
- PDFunctionType0 - Class in org.apache.pdfbox.pdmodel.common.function
-
This class represents a type 0 function in a PDF document.
- PDFunctionType0(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Constructor.
- PDFunctionType2 - Class in org.apache.pdfbox.pdmodel.common.function
-
This class represents a type 2 function in a PDF document.
- PDFunctionType2(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType2
-
Constructor.
- PDFunctionType3 - Class in org.apache.pdfbox.pdmodel.common.function
-
This class represents a type 3 function in a PDF document.
- PDFunctionType3(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType3
-
Constructor.
- PDFunctionType4 - Class in org.apache.pdfbox.pdmodel.common.function
-
This class represents a type 4 function in a PDF document.
- PDFunctionType4(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.function.PDFunctionType4
-
Constructor.
- PDFXrefStreamParser - Class in org.apache.pdfbox.pdfparser
-
This will parse a PDF 1.5 (or better) Xref stream and
extract the xref information from the stream.
- PDFXrefStreamParser(COSStream, COSDocument, boolean, XrefTrailerResolver) - Constructor for class org.apache.pdfbox.pdfparser.PDFXrefStreamParser
-
Constructor.
- PDGamma - Class in org.apache.pdfbox.pdmodel.graphics.color
-
A gamma array, or collection of three floating point parameters used for
color operations.
- PDGamma() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
Constructor.
- PDGamma(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
Constructor from COS object.
- PDGraphicsState - Class in org.apache.pdfbox.pdmodel.graphics
-
This class will hold the current state of the graphics parameters when executing a
content stream.
- PDGraphicsState() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Default constructor.
- PDGraphicsState(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Constructor with a given pagesize to initialize the clipping path.
- PDICCBased - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a ICC profile color space.
- PDICCBased(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
Default constructor, creates empty stream.
- PDICCBased(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
Constructor.
- PDIndexed - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents an Indexed color space.
- PDIndexed() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
Constructor, default DeviceRGB, hival 255.
- PDIndexed(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
Constructor.
- PDInlinedImage - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
This class represents an inlined image.
- PDInlinedImage() - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
-
- PDJavascriptNameTreeNode - Class in org.apache.pdfbox.pdmodel
-
This class holds all of the name trees that are available at the document level.
- PDJavascriptNameTreeNode() - Constructor for class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
-
Constructor.
- PDJavascriptNameTreeNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDJavascriptNameTreeNode
-
Constructor.
- PDJpeg - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
An image class for JPegs.
- PDJpeg(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
-
Standard constructor.
- PDJpeg(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
-
Construct from a stream.
- PDJpeg(PDDocument, BufferedImage) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
-
Construct from a buffered image.
- PDJpeg(PDDocument, BufferedImage, float) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDJpeg
-
Construct from a buffered image.
- PDLab - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Lab color space.
- PDLab() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
Constructor.
- PDLab(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
Constructor with array.
- PDLayoutAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
A Layout attribute object.
- PDLayoutAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Default constructor.
- PDLayoutAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Creates a new Layout attribute object with a given dictionary.
- PDLineDashPattern - Class in org.apache.pdfbox.pdmodel.graphics
-
This class represents the line dash pattern for a graphics state.
- PDLineDashPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
Creates a blank line dash pattern.
- PDLineDashPattern(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
Constructs a line dash pattern from an existing array.
- PDLineDashPattern(COSArray, int) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
Constructs a line dash pattern from an existing array.
- PDListAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
A List attribute object.
- PDListAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
-
Default constructor.
- PDListAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
-
Creates a new List attribute object with a given dictionary.
- PDMarkedContent - Class in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent
-
A marked content.
- PDMarkedContent(COSName, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
-
Creates a new marked content object.
- PDMarkedContentReference - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A marked-content reference.
- PDMarkedContentReference() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Default constructor
- PDMarkedContentReference(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Constructor for an existing marked content reference.
- PDMarkInfo - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
The MarkInfo provides additional information relevant to specialized
uses of structured documents.
- PDMarkInfo() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Default Constructor.
- PDMarkInfo(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Constructor for an existing MarkInfo element.
- PDMatrix - Class in org.apache.pdfbox.pdmodel.common
-
This class will be used for matrix manipulation.
- PDMatrix() - Constructor for class org.apache.pdfbox.pdmodel.common.PDMatrix
-
Constructor.
- PDMatrix(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMatrix
-
Constructor.
- PDMeasureDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
-
This class represents a measure dictionary.
- PDMeasureDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
Constructor.
- PDMeasureDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
Constructor.
- PDMemoryStream - Class in org.apache.pdfbox.pdmodel.common
-
A PDStream represents a stream in a PDF document.
- PDMemoryStream(byte[]) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will create a new PDStream object.
- PDMetadata - Class in org.apache.pdfbox.pdmodel.common
-
This class represents metadata for various objects in a PDF document.
- PDMetadata(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
-
This will create a new PDMetadata object.
- PDMetadata(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
-
Constructor.
- PDMetadata(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDMetadata
-
Constructor.
- PDMMType1Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the Multiple Master Type1 Font.
- PDMMType1Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDMMType1Font
-
Constructor.
- PDMMType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDMMType1Font
-
Constructor.
- PDNamedDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page by referencing it with a name.
- PDNamedDestination(COSString) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Constructor.
- PDNamedDestination(COSName) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Constructor.
- PDNamedDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Default constructor.
- PDNamedDestination(String) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Default constructor.
- PDNamedTextStream - Class in org.apache.pdfbox.pdmodel.common
-
A named text stream is a combination of a name and a PDTextStream object.
- PDNamedTextStream() - Constructor for class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
Constructor.
- PDNamedTextStream(COSName, COSBase) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
Constructor.
- PDNameTreeNode - Class in org.apache.pdfbox.pdmodel.common
-
This class represends a PDF Name tree.
- PDNameTreeNode(Class) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Constructor.
- PDNameTreeNode(COSDictionary, Class) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Constructor.
- PDNumberFormatDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
-
This class represents a number format dictionary.
- PDNumberFormatDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
Constructor.
- PDNumberFormatDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
Constructor.
- PDNumberTreeNode - Class in org.apache.pdfbox.pdmodel.common
-
This class represents a PDF Number tree.
- PDNumberTreeNode(Class<?>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Constructor.
- PDNumberTreeNode(COSDictionary, Class<?>) - Constructor for class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Constructor.
- PDObjectReference - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
An object reference.
- PDObjectReference() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Default Constructor.
- PDObjectReference(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Constructor for an existing object reference.
- PDObjectStream - Class in org.apache.pdfbox.pdmodel.common
-
A PDStream represents a stream in a PDF document.
- PDObjectStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
Constructor.
- PDOptionalContentGroup - Class in org.apache.pdfbox.pdmodel.graphics.optionalcontent
-
This class represents an optional content group (OCG).
- PDOptionalContentGroup(String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
Creates a new optional content group (OCG).
- PDOptionalContentGroup(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
- 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
-
- PDOptionalContentProperties.BaseState - Enum in org.apache.pdfbox.pdmodel.graphics.optionalcontent
-
Enumeration for the BaseState dictionary entry on the "D" dictionary.
- PDOutlineItem - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
-
This represents an outline in a pdf document.
- PDOutlineItem() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Default Constructor.
- PDOutlineItem(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Constructor for an existing outline item.
- PDOutlineNode - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline
-
This represents an node in an outline in a pdf document.
- PDOutlineNode() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Default Constructor.
- PDOutlineNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Default Constructor.
- PDPage - Class in org.apache.pdfbox.pdmodel
-
This represents a single page in a PDF document.
- PDPage() - Constructor for class org.apache.pdfbox.pdmodel.PDPage
-
Creates a new instance of PDPage with a size of 8.5x11.
- PDPage(PDRectangle) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
-
Creates a new instance of PDPage.
- PDPage(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPage
-
Creates a new instance of PDPage.
- PDPageable - Class in org.apache.pdfbox.pdmodel
-
Adapter class that implements the
Pageable and
Printable
interfaces for printing a given PDF document.
- PDPageable(PDDocument, PrinterJob) - Constructor for class org.apache.pdfbox.pdmodel.PDPageable
-
Creates a
Pageable adapter for the given PDF document and
printer job.
- PDPageable(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.PDPageable
-
- PDPageAdditionalActions - Class in org.apache.pdfbox.pdmodel.interactive.action
-
This class represents a page object's dictionary of actions
that occur due to events.
- PDPageAdditionalActions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
Default constructor.
- PDPageAdditionalActions(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
Constructor.
- PDPageContentStream - Class in org.apache.pdfbox.pdmodel.edit
-
This class is a convenience for creating page content streams.
- PDPageContentStream(PDDocument, PDPage) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Create a new PDPage content stream.
- PDPageContentStream(PDDocument, PDPage, boolean, boolean) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Create a new PDPage content stream.
- PDPageContentStream(PDDocument, PDPage, boolean, boolean, boolean) - Constructor for class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Create a new PDPage content stream.
- PDPageDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page, see subclasses for specific parameters.
- PDPageDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Constructor to create empty page destination.
- PDPageDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Constructor to create empty page destination.
- PDPageFitDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page and the page contents will be magnified to just
fit on the screen.
- PDPageFitDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
-
Default constructor.
- PDPageFitDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
-
Constructor from an existing destination array.
- PDPageFitHeightDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page at a x location and the height is magnified
to just fit on the screen.
- PDPageFitHeightDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
-
Default constructor.
- PDPageFitHeightDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
-
Constructor from an existing destination array.
- PDPageFitRectangleDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page at a y location and the width is magnified
to just fit on the screen.
- PDPageFitRectangleDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Default constructor.
- PDPageFitRectangleDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Constructor from an existing destination array.
- PDPageFitWidthDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page at a y location and the width is magnified
to just fit on the screen.
- PDPageFitWidthDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
-
Default constructor.
- PDPageFitWidthDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
-
Constructor from an existing destination array.
- PDPageLabelRange - Class in org.apache.pdfbox.pdmodel.common
-
Contains information for a page label range.
- PDPageLabelRange() - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Creates a new empty page label range object.
- PDPageLabelRange(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Creates a new page label range object from the given dictionary.
- PDPageLabels - Class in org.apache.pdfbox.pdmodel.common
-
Represents the page label dictionary of a document.
- PDPageLabels(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Creates an empty page label dictionary for the given document.
- PDPageLabels(PDDocument, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Creates an page label dictionary for a document using the information in
the given COS dictionary.
- PDPageNode - Class in org.apache.pdfbox.pdmodel
-
This represents a page node in a pdf document.
- PDPageNode() - Constructor for class org.apache.pdfbox.pdmodel.PDPageNode
-
Creates a new instance of PDPage.
- PDPageNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDPageNode
-
Creates a new instance of PDPage.
- PDPageXYZDestination - Class in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination
-
This represents a destination to a page at an x,y coordinate with a zoom setting.
- PDPageXYZDestination() - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Default constructor.
- PDPageXYZDestination(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Constructor from an existing destination array.
- PDPattern - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Pattern color space.
- PDPattern() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
-
Default constructor.
- PDPattern(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDPattern
-
Constructor.
- PDPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
-
This represents the resources for a pattern colorspace.
- PDPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
Default constructor.
- PDPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
Prepopulated pattern resources.
- PDPixelMap - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
This class contains a PixelMap Image.
- PDPixelMap(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
-
Standard constructor.
- PDPixelMap(PDDocument, BufferedImage) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDPixelMap
-
Construct a pixel map image from an AWT image.
- PDPrintFieldAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
A PrintField attribute object.
- PDPrintFieldAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Default constructor.
- PDPrintFieldAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Creates a new PrintField attribute object with a given dictionary.
- PDPropertyList - Class in org.apache.pdfbox.pdmodel.markedcontent
-
This class represents a property list used for the marked content feature to map a resource name
to a dictionary.
- PDPropertyList() - Constructor for class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
-
Creates a new property list.
- PDPropertyList(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
-
- PDPushButton - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a PDPushButton.
- PDPushButton(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
-
- PDRadioCollection - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a Radio Collection.
- PDRadioCollection(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
-
- PDRange - Class in org.apache.pdfbox.pdmodel.common
-
This class will be used to signify a range.
- PDRange() - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
-
Constructor with an initial range of 0..1.
- PDRange(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
-
Constructor assumes a starting index of 0.
- PDRange(COSArray, int) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRange
-
Constructor with an index into an array.
- PDRectangle - Class in org.apache.pdfbox.pdmodel.common
-
This represents a rectangle in a PDF document.
- PDRectangle() - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
-
Constructor.
- PDRectangle(float, float) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
-
Constructor.
- PDRectangle(BoundingBox) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
-
Constructor.
- PDRectangle(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.common.PDRectangle
-
Constructor.
- PDRectlinearMeasureDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
-
This class represents a rectlinear measure dictionary.
- PDRectlinearMeasureDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
Constructor.
- PDRectlinearMeasureDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
Constructor.
- PDResources - Class in org.apache.pdfbox.pdmodel
-
This represents a set of resources available at the page/pages/stream level.
- PDResources() - Constructor for class org.apache.pdfbox.pdmodel.PDResources
-
Default constructor.
- PDResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.PDResources
-
Prepopulated resources.
- PDSeparation - Class in org.apache.pdfbox.pdmodel.graphics.color
-
This class represents a Separation color space.
- PDSeparation() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
Constructor.
- PDSeparation(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
Constructor.
- PDShading - Class in org.apache.pdfbox.pdmodel.graphics
-
This class represents a Shading Pattern color space.
- PDShading() - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Default constructor.
- PDShading(COSName, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.PDShading
-
Constructor.
- PDShadingPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
-
This represents the resources for a shading pattern.
- PDShadingPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
Default constructor.
- PDShadingPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
Prepopulated pattern resources.
- PDShadingResources - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a shading.
- PDShadingResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
Default constructor.
- PDShadingResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
Constructor using the given shading dictionary.
- PDShadingType1 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a function based shading.
- PDShadingType1(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
Constructor using the given shading dictionary.
- PDShadingType2 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for an axial shading.
- PDShadingType2(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
Constructor using the given shading dictionary.
- PDShadingType3 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a radial shading.
- PDShadingType3(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType3
-
Constructor using the given shading dictionary.
- PDShadingType4 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Meshes).
- PDShadingType4(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
Constructor using the given shading dictionary.
- PDShadingType5 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a shading type 5 (Lattice-Form Gouraud-Shaded Triangle Meshes).
- PDShadingType5(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
Constructor using the given shading dictionary.
- PDShadingType6 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a shading type 6 (Coons Patch Meshes).
- PDShadingType6(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType6
-
Constructor using the given shading dictionary.
- PDShadingType7 - Class in org.apache.pdfbox.pdmodel.graphics.shading
-
This represents resources for a shading type 7 (Tensor-Product Patch Meshes).
- PDShadingType7(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType7
-
Constructor using the given shading dictionary.
- PDSignature - Class in org.apache.pdfbox.pdmodel.interactive.digitalsignature
-
This represents a digital signature that can be attached to a document.
- PDSignature() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Default constructor.
- PDSignature(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Constructor.
- PDSignature - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a signature.
- PDSignature(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
-
- PDSignatureField - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a signature.
- PDSignatureField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
- PDSignatureField(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
- PDSimpleFileSpecification - Class in org.apache.pdfbox.pdmodel.common.filespecification
-
A file specification that is just a string.
- PDSimpleFileSpecification() - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
-
Constructor.
- PDSimpleFileSpecification(COSString) - Constructor for class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
-
Constructor.
- PDSimpleFont - Class in org.apache.pdfbox.pdmodel.font
-
This class contains implementation details of the simple pdf fonts.
- PDSimpleFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
Constructor.
- PDSimpleFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
Constructor.
- PDStandardAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
A standard attribute object.
- PDStandardAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Default constructor.
- PDStandardAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Creates a new standard attribute object with a given dictionary.
- PDStandardEncryption - Class in org.apache.pdfbox.pdmodel.encryption
-
Deprecated.
Made deprecated by the new security layer of PDFBox. Use SecurityHandlers instead.
- PDStandardEncryption() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Default constructor that uses Version 2, Revision 3, 40 bit encryption,
all permissions allowed.
- PDStandardEncryption(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Constructor from existing dictionary.
- PDStream - Class in org.apache.pdfbox.pdmodel.common
-
A PDStream represents a stream in a PDF document.
- PDStream() - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
-
This will create a new PDStream object.
- PDStream(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
-
This will create a new PDStream object.
- PDStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
-
Constructor.
- PDStream(PDDocument, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
-
Constructor.
- PDStream(PDDocument, InputStream, boolean) - Constructor for class org.apache.pdfbox.pdmodel.common.PDStream
-
Constructor.
- PDStructureElement - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A structure element.
- PDStructureElement(String, PDStructureNode) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Constructor with required values.
- PDStructureElement(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Constructor for an existing structure element.
- PDStructureNode - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A node in the structure tree.
- PDStructureNode(String) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Constructor.
- PDStructureNode(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Constructor for an existing structure node.
- PDStructureTreeRoot - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A root of a structure tree.
- PDStructureTreeRoot() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Default Constructor.
- PDStructureTreeRoot(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Constructor for an existing structure element.
- PDTableAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
A Table attribute object.
- PDTableAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Default constructor.
- PDTableAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Creates a new Table attribute object with a given dictionary.
- PDTextbox - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling the PDF field as a textbox.
- PDTextbox(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
-
- PDTextbox(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDTextbox
-
- PDTextState - Class in org.apache.pdfbox.pdmodel.text
-
This class will hold the current state of the text parameters when executing a
content stream.
- PDTextState() - Constructor for class org.apache.pdfbox.pdmodel.text.PDTextState
-
- PDTextStream - Class in org.apache.pdfbox.pdmodel.common
-
A PDTextStream class is used when the PDF specification supports either
a string or a stream for the value of an object.
- PDTextStream(COSString) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
-
Constructor.
- PDTextStream(String) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
-
Constructor.
- PDTextStream(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTextStream
-
Constructor.
- PDThread - Class in org.apache.pdfbox.pdmodel.interactive.pagenavigation
-
This a single thread in a PDF document.
- PDThread(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Constructor that is used for a preexisting dictionary.
- PDThread() - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Default constructor.
- PDThreadBead - Class in org.apache.pdfbox.pdmodel.interactive.pagenavigation
-
This a single bead in a thread in a PDF document.
- PDThreadBead(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Constructor that is used for a preexisting dictionary.
- PDThreadBead() - Constructor for class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Default constructor.
- PDTilingPatternResources - Class in org.apache.pdfbox.pdmodel.graphics.pattern
-
This represents the resources for a tiling pattern.
- PDTilingPatternResources() - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
Default constructor.
- PDTilingPatternResources(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
Prepopulated pattern resources.
- PDTristimulus - Class in org.apache.pdfbox.pdmodel.graphics.color
-
A tristimulus, or collection of three floating point parameters used for
color operations.
- PDTristimulus() - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
Constructor.
- PDTristimulus(COSArray) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
Constructor from COS object.
- PDTristimulus(float[]) - Constructor for class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
Constructor from COS object.
- PDTrueTypeFont - Class in org.apache.pdfbox.pdmodel.font
-
This is the TrueType implementation of fonts.
- PDTrueTypeFont() - Constructor for class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
-
Constructor.
- PDTrueTypeFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDTrueTypeFont
-
Constructor.
- PDType0Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the Type0 Font.
- PDType0Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType0Font
-
Constructor.
- PDType0Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType0Font
-
Constructor.
- PDType1AfmPfbFont - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the Type1 Font
with a afm and a pfb file.
- PDType1AfmPfbFont(PDDocument, String) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
-
Create a new object.
- PDType1AfmPfbFont(PDDocument, InputStream, InputStream) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1AfmPfbFont
-
Create a new object.
- PDType1CFont - Class in org.apache.pdfbox.pdmodel.font
-
This class represents a CFF/Type2 Font (aka Type1C Font).
- PDType1CFont(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1CFont
-
Constructor.
- PDType1Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the Type1 Font.
- PDType1Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
-
Constructor.
- PDType1Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
-
Constructor.
- PDType1Font(String) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType1Font
-
Constructor.
- PDType3Font - Class in org.apache.pdfbox.pdmodel.font
-
This is implementation of the Type3 Font.
- PDType3Font() - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3Font
-
Constructor.
- PDType3Font(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.font.PDType3Font
-
Constructor.
- PDTypedDictionaryWrapper - Class in org.apache.pdfbox.pdmodel.common
-
A wrapper for a COS dictionary including Type information.
- PDTypedDictionaryWrapper(String) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
-
Creates a new instance with a given type.
- PDTypedDictionaryWrapper(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.common.PDTypedDictionaryWrapper
-
Creates a new instance with a given COS dictionary.
- PDUnknownField - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This class represents a form field with an unknown type.
- PDUnknownField(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
-
- PDURIDictionary - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
This is the implementation of an URI dictionary.
- PDURIDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
Constructor.
- PDURIDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
Constructor.
- PDUserAttributeObject - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A User attribute object.
- PDUserAttributeObject() - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
-
Default constructor
- PDUserAttributeObject(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
-
- PDUserProperty - Class in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
-
A user property.
- PDUserProperty(PDUserAttributeObject) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Creates a new user property.
- PDUserProperty(COSDictionary, PDUserAttributeObject) - Constructor for class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Creates a user property with a given dictionary.
- PDVariableText - Class in org.apache.pdfbox.pdmodel.interactive.form
-
A class for handling PDF fields that display text.
- PDVariableText(PDAcroForm) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
- PDVariableText(PDAcroForm, COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
- PDViewerPreferences - Class in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
This is the document viewing preferences.
- PDViewerPreferences(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Constructor that is used for a preexisting dictionary.
- PDViewerPreferences.BOUNDARY - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
Enumeration containing all valid values for boundaries.
- PDViewerPreferences.DUPLEX - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
Enumeration containing all valid values for duplex.
- PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
Enumeration containing all valid values for NonFullScreenPageMode.
- PDViewerPreferences.PRINT_SCALING - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
Enumeration containing all valid values for printscaling.
- PDViewerPreferences.READING_DIRECTION - Enum in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
-
Enumeration containing all valid values for ReadingDirection.
- PDViewportDictionary - Class in org.apache.pdfbox.pdmodel.interactive.measurement
-
This class represents a viewport dictionary.
- PDViewportDictionary() - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
Constructor.
- PDViewportDictionary(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
Constructor.
- PDWindowsLaunchParams - Class in org.apache.pdfbox.pdmodel.interactive.action.type
-
Launch paramaters for the windows OS.
- PDWindowsLaunchParams() - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Default constructor.
- PDWindowsLaunchParams(COSDictionary) - Constructor for class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Constructor.
- PDXFA - Class in org.apache.pdfbox.pdmodel.interactive.form
-
This class represents an XML Forms Architecture Data packet.
- PDXFA(COSBase) - Constructor for class org.apache.pdfbox.pdmodel.interactive.form.PDXFA
-
Constructor.
- PDXObject - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
The base class for all XObjects in the PDF document.
- PDXObject(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Standard constructor.
- PDXObject(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Standard constuctor.
- PDXObject(PDDocument) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Standard constuctor.
- PDXObjectForm - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
A form xobject.
- PDXObjectForm(PDStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
Standard constuctor.
- PDXObjectForm(COSStream) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
Standard constuctor.
- PDXObjectImage - Class in org.apache.pdfbox.pdmodel.graphics.xobject
-
The prototype for all PDImages.
- PDXObjectImage(PDStream, String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Standard constructor.
- PDXObjectImage(PDDocument, String) - Constructor for class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Standard constuctor.
- peek() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
-
This will peek at the next byte.
- peek() - Method in class org.apache.pdfbox.io.PushBackInputStream
-
This will peek at the next byte.
- PG - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PLACEMENT_BEFORE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Placement: Before: Placed so that the before edge of the element???s
allocation rectangle coincides with that of the nearest enclosing
reference area.
- PLACEMENT_BLOCK - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Placement: Block: Stacked in the block-progression direction within an
enclosing reference area or parent BLSE.
- PLACEMENT_END - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Placement: End: Placed so that the end edge of the element???s allocation
rectangle coincides with that of the nearest enclosing reference area.
- PLACEMENT_INLINE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Placement: Inline: Packed in the inline-progression direction within an
enclosing BLSE.
- PLACEMENT_START - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Placement: Start: Placed so that the start edge of the element???s
allocation rectangle coincides with that of the nearest enclosing
reference area.
- popInt() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
-
Pops a value of type int from the stack.
- popNumber() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
-
Pops a number (int or real) from the stack.
- popReal() - Method in class org.apache.pdfbox.pdmodel.common.function.type4.ExecutionContext
-
Pops a number from the stack and returns it as a real value.
- populateBuffer(InputStream, byte[]) - Static method in class org.apache.pdfbox.io.IOUtils
-
Populates the given buffer with data read from the input stream.
- PositionWrapper - Class in org.apache.pdfbox.util
-
wrapper of TextPosition that adds flags to track
status as linestart and paragraph start positions.
- PositionWrapper(TextPosition) - Constructor for class org.apache.pdfbox.util.PositionWrapper
-
Constructs a PositionWrapper around the specified TextPosition object.
- potentiallyNotifyChanged(COSBase, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Notifies the attribute object change listeners if the attribute is changed.
- PREDICTOR - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PredictorAlgorithm - Class in org.apache.pdfbox.pdmodel.graphics.predictor
-
Implements different PNG predictor algorithms that is used in PDF files.
- PredictorAlgorithm() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
-
Prepare the document for encryption.
- prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
Prepare the document for encryption.
- prepareDocumentForEncryption(PDDocument) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Prepare document for encryption.
- prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
-
Prepares everything to decrypt the document.
- prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
Prepares everything to decrypt the document.
- prepareForDecryption(PDEncryptionDictionary, COSArray, DecryptionMaterial) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Prepares everything to decrypt the document.
- PREV - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- print() - Method in class org.apache.pdfbox.cos.COSDocument
-
This will print contents to stdout.
- print(PrinterJob) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- print() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will send the PDF document to a printer.
- print(Graphics, PageFormat, int) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
- print(Graphics, PageFormat, int) - Method in class org.apache.pdfbox.pdmodel.PDPageable
-
Prints the page at the given index.
- PRINT_AREA - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PRINT_CLIP - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PRINT_SCALING - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PrintPDF - Class in org.apache.pdfbox
-
This is a command line program that will print a PDF document.
- printStackTrace(PrintStream) - Method in exception org.apache.pdfbox.exceptions.WrappedException
-
Prints this throwable and its backtrace to the specified print stream.
- PRIVATE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
-
Private
- PROC_SET - Static variable in class org.apache.pdfbox.cos.COSName
-
The COSName value for "ProcSet".
- PROC_SET - Static variable in class org.apache.pdfbox.Overlay
-
- proceedDecryption() - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
This method must be called by an implementation of this class to really proceed
to decryption.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginMarkedContentSequence
-
process the operator.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginMarkedContentSequenceWithProperties
-
process the operator.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.BeginText
-
process : BT : Begin text object.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.CloseAndStrokePath
-
s close and stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.Concatenate
-
process : cm : Concatenate matrix to current transformation matrix.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.EndMarkedContentSequence
-
process the operator.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.EndText
-
process : ET : End text object.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.GRestore
-
process : Q : Restore graphics state.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.GSave
-
process : q : Save graphics state.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.Invoke
-
process : Do - Invoke a named xobject.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveAndShow
-
' Move to next line and show text.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveText
-
process : Td : Move text position.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.MoveTextSetLeading
-
process : TD Move text position and set leading.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.NextLine
-
process : T* Move to start of next text line.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
-
process the operator.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.AppendRectangleToPath
-
process : re : append rectangle to path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.BeginInlineImage
-
process : BI : begin inline image.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClipEvenOddRule
-
process : W* : set clipping path using even odd rule.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClipNonZeroRule
-
process : W : Set the clipping path using non zero winding rule.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CloseFillEvenOddAndStrokePath
-
fill and stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CloseFillNonZeroAndStrokePath
-
fill and stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.ClosePath
-
process : h : Close path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveTo
-
process : c : Append curved segment to path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateFinalPoint
-
process : y : Append curved segment to path (final point replicated).
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.CurveToReplicateInitialPoint
-
process : v : Append curved segment to path (initial point replicated).
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.EndPath
-
process : n : End path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddAndStrokePath
-
fill and stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillEvenOddRule
-
process : f* : fill path using even odd rule.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroAndStrokePath
-
fill and stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.FillNonZeroRule
-
process : F/f : fill path using non zero winding rule.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.Invoke
-
process : Do : Paint the specified XObject (section 4.7).
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.LineTo
-
process : l : Append straight line segment to path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.MoveTo
-
process : m : Begin new subpath.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineCapStyle
-
Set the line cap style.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineDashPattern
-
Set the line dash pattern.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineJoinStyle
-
Set the line cap style.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineMiterLimit
-
Set the line dash pattern.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SetLineWidth
-
w Set line width.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.SHFill
-
process : sh : shade fill the clipping area.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.pagedrawer.StrokePath
-
S stroke the path.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetCharSpacing
-
process : Tc Set character spacing.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetGraphicsStateParameters
-
gs Set parameters from graphics state parameter dictionary.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetHorizontalTextScaling
-
Tz Set horizontal text scaling.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineCapStyle
-
Set the line cap style.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineDashPattern
-
Set the line dash pattern.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineJoinStyle
-
Set the line cap style.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineMiterLimit
-
w Set miter limit.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetLineWidth
-
w Set line width.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetMatrix
-
Tm Set text matrix and text line matrix.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetMoveAndShow
-
" Set word and character spacing, move to next line, and show text.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingCalRGBColor
-
rg Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingCMYKColor
-
k Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingColor
-
sc,scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingColorSpace
-
cs Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingDeviceN
-
scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingGrayColor
-
rg Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingICCBasedColor
-
scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingPattern
-
Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingRGBColor
-
rg Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetNonStrokingSeparation
-
scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingCalRGBColor
-
RG Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingCMYKColor
-
K Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingColor
-
SC,SCN Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingColorSpace
-
CS Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingDeviceN
-
scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingGrayColor
-
RG Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingICCBasedColor
-
scn Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingPattern
-
Set pattern instead of a color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingRGBColor
-
RG Set color space for stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetStrokingSeparation
-
scn Set color space for non stroking operations.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextFont
-
Tf selectfont Set text font and size.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextLeading
-
TL Set text leading.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextRenderingMode
-
Tr Set text rendering mode.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetTextRise
-
Ts Set text rise.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.SetWordSpacing
-
Tw Set word spacing.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.ShowText
-
Tj show Show text.
- process(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.operator.ShowTextGlyph
-
TJ Show text, allowing individual glyph positioning.
- processCosObject(String) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
- processEncodedText(byte[]) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Process encoded text from the PDF Stream.
- processNextPage(PDPage) - Method in class org.apache.pdfbox.util.Splitter
-
Interface to start processing a new page.
- processOperator(PDFOperator, List) - Method in class org.apache.pdfbox.pdmodel.font.Type3StreamParser
-
This is used to handle an operation.
- processOperator(String, List<COSBase>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
This is used to handle an operation.
- processOperator(PDFOperator, List<COSBase>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
This is used to handle an operation.
- processPage(PDPage, COSStream) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will process the contents of a page.
- processPages(List<COSObjectable>) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will process all of the pages and the text that is in them.
- processPages(List) - Method in class org.apache.pdfbox.util.Splitter
-
Interface method to handle the start of the page processing.
- processStream(PDPage, PDResources, COSStream) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
This will process the contents of the stream.
- processSubStream(PDPage, PDResources, COSStream) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Process a sub stream of the current stream.
- processTextPosition(TextPosition) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
You should override this method if you want to perform an action when a
text is being processed.
- processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFMarkedContentExtractor
-
This will process a TextPosition object and add the
text to the list of characters on a page.
- processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
A method provided as an event interface to allow a subclass to perform
some specific functionality when text needs to be processed.
- processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will process a TextPosition object and add the
text to the list of characters on a page.
- processTextPosition(TextPosition) - Method in class org.apache.pdfbox.util.PDFTextStripperByArea
-
This will process a TextPosition object and add the
text to the list of characters on a page.
- PRODUCER - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- PROPERTIES - Static variable in class org.apache.pdfbox.cos.COSName
-
The COSName value for "Properties".
- protect(ProtectionPolicy) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Protects the document with the protection policy pp.
- PROTECTION_POLICY_CLASS - Static variable in class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Protection policy class for this handler.
- ProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
-
This class represents the protection policy to apply to a document.
- ProtectionPolicy() - Constructor for class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
-
- PublicKeyDecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
-
This class holds necessary information to decrypt a PDF document
protected by the public key security handler.
- PublicKeyDecryptionMaterial(KeyStore, String, String) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyDecryptionMaterial
-
Create a new public key decryption material.
- PublicKeyProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
-
This class represents the protection policy to use to protect
a document with the public key security handler as described
in the PDF specification 1.6 p104.
- PublicKeyProtectionPolicy() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
-
Constructor for encryption.
- PublicKeyRecipient - Class in org.apache.pdfbox.pdmodel.encryption
-
Represents a recipient in the public key protection policy.
- PublicKeyRecipient() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
-
- PublicKeySecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
-
This class implements the public key security handler
described in the PDF specification.
- PublicKeySecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
-
Constructor.
- PublicKeySecurityHandler(PublicKeyProtectionPolicy) - Constructor for class org.apache.pdfbox.pdmodel.encryption.PublicKeySecurityHandler
-
Constructor used for encryption.
- PushBackInputStream - Class in org.apache.pdfbox.io
-
A simple subclass that adds a few convience methods.
- PushBackInputStream(InputStream, int) - Constructor for class org.apache.pdfbox.io.PushBackInputStream
-
Constructor.
- put(Object, Object) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
- putAll(Map) - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
- putMapping(COSName, PDOptionalContentGroup) - Method in class org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
-
Puts a mapping from a resource name to an optional content group.
- putObjectInPool(COSBase, long, long) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
- S - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SA - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- save(File) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save this document to the filesystem.
- save(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save this document to the filesystem.
- save(OutputStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save the document to an output stream.
- save(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will save this document to the filesystem.
- save(OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will save the document to an output stream.
- saveGraphicsState() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
q operator.
- saveIncremental(String) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- saveIncremental(FileInputStream, OutputStream) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- saveXFDF(File) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save this document to the filesystem.
- saveXFDF(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save this document to the filesystem.
- saveXFDF(Writer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will save the document to an output stream and close the stream.
- SCALE_OPTION_ALWAYS - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
A scale option.
- SCALE_OPTION_NEVER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
A scale option.
- SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
A scale option.
- SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
A scale option.
- SCALE_TYPE_ANAMORPHIC - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
Scale to fill with of annotation, disregarding aspect ratio.
- SCALE_TYPE_PROPORTIONAL - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
Scale to fit width or height, smaller of two, while retaining aspect ration.
- SCOPE - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
- SCOPE_BOTH - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Scope: Both
- SCOPE_COLUMN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Scope: Column
- SCOPE_ROW - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Scope: Row
- SE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SECT - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
-
Sect
- SecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
-
This class represents a security handler as described in the PDF specifications.
- SecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
- SecurityHandlersManager - Class in org.apache.pdfbox.pdmodel.encryption
-
This class manages security handlers for the application.
- seek(int) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
-
Position the stream at a given index.
- seek(long) - Method in class org.apache.pdfbox.io.PushBackInputStream
-
Allows to seek to another position within stream in case the underlying
stream implements
RandomAccessRead.
- seek(long) - Method in class org.apache.pdfbox.io.RandomAccessBuffer
-
Seek to a position in the data.
- seek(long) - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
-
Seeks to new position.
- seek(long) - Method in class org.apache.pdfbox.io.RandomAccessFile
-
Seek to a position in the data.
- seek(long) - Method in interface org.apache.pdfbox.io.RandomAccessRead
-
Seek to a position in the data.
- SEPARATION - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SequentialRead - Interface in org.apache.pdfbox.io
-
An interface allowing sequential read operations.
- set(int, COSBase) - Method in class org.apache.pdfbox.cos.COSArray
-
This will set an object at a specific index.
- set(int, int) - Method in class org.apache.pdfbox.cos.COSArray
-
This will set an object at a specific index.
- set(int, COSObjectable) - Method in class org.apache.pdfbox.cos.COSArray
-
This will set an object at a specific index.
- set(int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Sets a bit at the given offset.
- set(int, Object) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
- SET_F - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SET_FF - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will set the form this field is on.
- setAcroForm(PDAcroForm) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the acro form for this catalog.
- setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the action that is associated with this field.
- setAction(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
- setAction(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
- setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Set the annotation action.
- setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Set the annotation action.
- setAction(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the action for this node.
- setActions(PDAnnotationAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Set the actions of the field.
- setActions(PDFormFieldAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Set the actions of the field.
- setActions(PDDocumentCatalogAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the additional actions for the document.
- setActions(PDPageAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
Set the page actions.
- setActualText(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the actual text (ActualText).
- setAdditionalActions(PDAdditionalActions) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the additional actions that are associated with this field.
- setAddMoreFormatting(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
There will some additional text formatting be added if addMoreFormatting
is set to true.
- setAES(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
- setAfter(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This will set the javascript code the will get execute after the import.
- setAfterColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Sets the colour for the after edge.
- setAllBorderColors(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same border colour for all four sides (BorderColor).
- setAllBorderStyles(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same border style for all four sides (BorderStyle).
- setAllBorderThicknesses(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same border thickness for all four sides (BorderThickness).
- setAllBorderThicknesses(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same border thickness for all four sides (BorderThickness).
- setAllCap(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setAllColumnWidths(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same column width for all columns (ColumnWidths).
- setAllColumnWidths(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same column width for all columns (ColumnWidths).
- setAllPaddings(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same padding for all four sides (Padding).
- setAllPaddings(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same padding for all four sides (Padding).
- setAllSecurityToBeRemoved(boolean) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
- setAllTBorderStyles(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same table border style for all four sides (TBorderStyle).
- setAllTPaddings(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same table padding for all four sides (TPadding).
- setAllTPaddings(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the same table padding for all four sides (TPadding).
- setAlphaConstants(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the stroke alpha constants property.
- setAlphaSource(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the alpha source property.
- setAlphaSourceFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the alpha source flag.
- setAlternateCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the alternate caption.
- setAlternateColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will set the alternate color space.
- setAlternateColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will set the alternate color space.
- setAlternateColorSpaces(List) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will set the list of alternate color spaces.
- setAlternateDescription(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the alternate description (Alt).
- setAlternateFieldName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will set the alternate name of the field.
- setAlternateName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Sets the alternate name of the field (Desc).
- setAngles(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the angles.
- setAnnotationFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the flags for this field.
- setAnnotationName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the name, a string intended to uniquely identify each annotation
within a page.
- setAnnotations(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the list of annotations.
- setAnnotations(List<PDAnnotation>) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the list of annotations.
- setAntiAlias(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will set the AntiAlias value.
- setAppearance(PDAppearanceDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the appearance associated with this annotation.
- setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Sets the appearance characteristics dictionary.
- setAppearanceDictionary(PDAppearanceDictionary) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the appearance dictionary.
- setAppearanceStream(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the annotations appearance stream name.
- setAppearanceStreamReference(FDFNamedPageReference) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the named page references.
- setAppearanceValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAppearance
-
This is the public method for setting the appearance stream.
- setARange(PDRange) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will set the a range for this color space.
- setAreas(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the areas.
- setArrayOfName(String, String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets an array of name values.
- setArrayOfNumber(String, float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets an array of float numbers.
- setArrayOfString(String, String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets an array of strings.
- setArtBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the ArtBox for this page.
- setArticleEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the end of an article.
- setArticleStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the beginning of an article.
- setArticleStart() - Method in class org.apache.pdfbox.util.PositionWrapper
-
Sets the isArticleStart() flag to true.
- setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the ascent for the font.
- setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the ascent for the font.
- setAscent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the ascent for the font.
- setAttachementName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
Set the name used to draw the attachement icon.
- setAttribute(String, COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDDefaultAttributeObject
-
Sets an attribute.
- setAttributes(Revisions<PDAttributeObject>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the attributes together with their revision numbers (A).
- setAttributes(PDDeviceNAttributes) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will set the color space attributes.
- setAuthor(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the author of the document.
- setAutomaticStrokeAdjustment(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the automatic stroke adjustment flag.
- setAverageCharTolerance(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the character width-based tolerance value that is used
to estimate where spaces in text should be added.
- setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the average width for the font.
- setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the average width for the font.
- setAverageWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the average width for the font.
- setB(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will set the b value of the tristimulus.
- setBackground(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will set the background.
- setBackground(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the background color.
- setBackgroundColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the background colour (BackgroundColor).
- setBase(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
- setBase(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDURIDictionary
-
This will set the base URI to be used in resolving relative URI references.
- setBaseColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will set the base color space.
- setBaseFont(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Set the PostScript name of the font.
- setBaselineShift(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance by which the element???s baseline shall be shifted
relative to that of its parent element (BaselineShift).
- setBaselineShift(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance by which the element???s baseline shall be shifted
relative to that of its parent element (BaselineShift).
- setBaseState(PDOptionalContentProperties.BaseState) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Sets the base state for optional content groups.
- setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the bounding box.
- setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the BBox (bounding box) for this Pattern.
- setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will set the BBox (bounding box) for this Shading.
- setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
This will set the BBox (bounding box) for this form.
- setBBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will set the rectangle specifying the location of the viewport.
- setBefore(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This will set the javascript code the will get execute before the import.
- setBeforeColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Sets the colour for the before edge.
- setBits(int, int, int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Sets a run of bits at the given offset to either 1 or 0.
- setBits(int, int) - Method in class org.apache.pdfbox.io.ccitt.PackedBitArray
-
Sets a run of bits at the given offset to either 1.
- setBitsInChunk(int) - Method in class org.apache.pdfbox.io.NBitInputStream
-
Setter for property bitsToRead.
- setBitsInChunk(int) - Method in class org.apache.pdfbox.io.NBitOutputStream
-
Setter for property bitsToRead.
- setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
Set the number of bits per component.
- setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
Set the number of bits per component.
- setBitsPerComponent(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Set the number of bits per component.
- setBitsPerComponent(int) - Method in class org.apache.pdfbox.util.ImageParameters
-
Set the number of bits per component.
- setBitsPerCoordinate(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
Set the number of bits per coordinate.
- setBitsPerCoordinate(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
Set the number of bits per coordinate.
- setBitsPerFlag(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
Set the number of bits per flag.
- setBitsPerSample(int) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
Set the number of bits that the output value will take up.
- setBl(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the annotation
loses the input focus.
- setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will set the BlackPoint tristimulus.
- setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will set the BlackPoint tristimulus.
- setBlackPoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will set the BlackPoint tristimulus.
- setBleedBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the BleedBox for this page.
- setBlockAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the alignment, in the block-progression direction, of content within
the table cell (BlockAlign).
- setBold(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the bold property of the text.
- setBoolean(String, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setBoolean(COSName, boolean) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setBorderColors(PDFourColours) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the border colours for four sides separately (BorderColor).
- setBorderColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the border color.
- setBorderEffect(PDBorderEffectDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will set the border effect dictionary, specifying effects to be applied
when drawing the line.
- setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
- setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
- setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
- setBorderStyle(PDBorderStyleDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
This will set the border style dictionary, specifying the width and dash
pattern used in drawing the line.
- setBorderStyles(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the border styles for four sides separately (BorderStyle).
- setBorderThicknesses(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the border thicknesses for four sides separately (BorderThickness).
- setBottom(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate
will be used.
- setBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
This will set the bounding box for this appearance stream.
- setBpp(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
- setBpp(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- setBRange(PDRange) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will set the b range for this color space.
- setByteRange(int[]) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will set a JavaScript action to be performed in order to recalculate
the value of this field when that of another field changes.
- setC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
This will set an action to be performed when the page
is closed.
- setCacheFields(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will tell this form to cache the fields into a Map structure
for fast access via the getField method.
- setCanAssembleDocument(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can insert/rotate/delete pages.
- setCanAssembleDocument(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can insert/rotate/delete pages.
- setCanExtractContent(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can extract content from the document.
- setCanExtractContent(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can extract content from the document.
- setCanExtractForAccessibility(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can extract content from the document for accessibility purposes.
- setCanExtractForAccessibility(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can extract content from the document for accessibility purposes.
- setCanFillInForm(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can fill in interactive forms.
- setCanFillInForm(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can fill in interactive forms.
- setCanModify(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can modify the document.
- setCanModify(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can modify the document.
- setCanModifyAnnotations(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can modify annotations.
- setCanModifyAnnotations(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can modify annotations.
- setCanPrint(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can print.
- setCanPrint(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can print.
- setCanPrintDegraded(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Set if the user can print the document in a degraded format.
- setCanPrintDegraded(boolean) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
Set if the user can print the document in a degraded format.
- setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the cap height for the font.
- setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the cap height for the font.
- setCapHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the cap height for the font.
- setCaption(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set if the contents are shown as a caption to the line.
- setCaptionHorizontalOffset(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the horizontal offset of the caption.
- setCaptionPositioning(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the caption positioning.
- setCaptionVerticalOffset(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the vertical offset of the caption.
- setCatalog(FDFCatalog) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDocument
-
This will set the FDF catalog for this FDF document.
- setCenterWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the center window preference.
- setChangeXs(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the changes along the x-axis.
- setChangeYs(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the changes along the y-axis.
- setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the character set for the font.
- setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the character set for the font.
- setCharacterSet(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the character set for the font.
- setCharacterSpacing(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the characterSpacing.
- SetCharSpacing - Class in org.apache.pdfbox.util.operator
-
- SetCharSpacing() - Constructor for class org.apache.pdfbox.util.operator.SetCharSpacing
-
- setCheckedState(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Sets the checked state.
- setCheckSum(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the check sum.
- setClassNames(Revisions<String>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the class names together with their revision numbers (C).
- setClearFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setClearFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setClearWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setClearWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setClippingPath(int) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Set the clipping Path.
- setColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the color to be used for drawing text and the default value for the
colour of table borders and text decorations (Color).
- setColor(String, PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets a colour.
- setColor(Color) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the annotation color.
- setColorantName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will set the separation name.
- setColorantNames(List<COSBase>) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will set the list of colorants.
- setColorants(Map) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceNAttributes
-
This will replace the existing colorant attribute.
- setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will set the current colorspace.
- setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will set the color space for the shading.
- setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
This will set the color space for this image.
- setColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.util.ImageParameters
-
This will set the color space for this image.
- setColorSpaces(Map<String, PDColorSpace>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of colorspaces.
- setColorSpaces(Map<String, PDColorSpace>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- setColorSpaceValue(float[]) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will update the colorspace values.
- setColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the colour used in drawing various elements.
- setColSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the number of columns in the enclosing table that shall be spanned
by the cell (ColSpan).
- setColSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Sets the number of columns in the enclosing table that shall be spanned
by the cell (ColSpan).
- setColumnCount(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the number of columns in the content of the grouping element
(ColumnCount).
- setColumnGap(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the desired space between all columns in the inline-progression
direction (ColumnGap).
- setColumnGap(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the desired space between all columns in the inline-progression
direction (ColumnGap).
- setColumnGaps(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the desired space between adjacent columns in the inline-progression
direction (ColumnGap), the first element specifying the space between the
first and second columns, the second specifying the space between the
second and third columns, and so on.
- setColumnWidths(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the column widths for the columns separately (ColumnWidths).
- setComb(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the comb bit.
- setConstantOpacity(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the constant opacity value used when rendering the
annotation (excluing any popup).
- 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
-
- setContents(PDStream) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the contents of this page.
- setContext(PDFStreamEngine) - Method in class org.apache.pdfbox.util.operator.OperatorProcessor
-
Set the processing context.
- setConversionFactor(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the conversion factor.
- setCoords(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
Sets the Coords entry for this shading.
- setCoordSystemOrigin(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the origin of the coordinate system.
- setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the creation date.
- setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the creation date.
- setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the the date and time the annotation was created.
- setCreationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the creation date of the document.
- setCreator(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the creator of the document.
- setCropBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the CropBox for this page.
- setCropBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will set the CropBox for this page.
- setCryptFilterMethod(COSName) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
This will set the crypt filter method.
- setCurrentClippingPath(Shape) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will set the current clipping path.
- setCurrentTransformationMatrix(Matrix) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Set the value of the CTM.
- setCustomMetadataValue(String, String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
Set the custom metadata value.
- setCYX(float) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the CYX factor.
- setD(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the mouse button
is pressed inside the annotation's active area.
- setD(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set the string specifying the default directory in standard DOS syntax.
- setD(COSBase) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will set the destination to jump to.
- setDashPattern(List) - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
This will replace the existing line dash pattern.
- setDashStyle(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will set the dash style used for drawing the border.
- setDate(String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Set the value of a date entry in the dictionary.
- setDate(COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Set the date object.
- setDate(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
The annotation modification date.
- setDecimalSeparator(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the text to be used as the decimal point in displaying numerical values.
- setDecodedStreamLength(int) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Set the decoded stream length.
- setDecodeParams(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will set the list of decode params.
- setDecodeParms(List) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will set the list of decode parameterss.
- setDecodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
This will set the decode values.
- setDecodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
This will set the decode values.
- setDecodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
This will set the decode values.
- setDecrypted() - Method in class org.apache.pdfbox.cos.COSDocument
-
Signals that the document is decrypted completely.
- setDecryptionCertificate(X509Certificate) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyProtectionPolicy
-
Setter of the property decryptionCertificate.
- setDefaultAppearanceString(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
This will set the default appearance string.
- setDefaultResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
This will set the default resources for the acroform.
- setDefaultWidth(long) - Method in class org.apache.pdfbox.pdmodel.font.PDCIDFont
-
This will set the default width for the glyphs of this font.
- setDenominator(int) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the precision or denominator of a fractional amount.
- setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the descent for the font.
- setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the descent for the font.
- setDescent(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the descent for the font.
- setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
-
This will set the destination to jump to.
- setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
The new destination value.
- setDestination(PDDestination) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the page destination for this node.
- setDestination(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
A convenience method that will create an XYZ destination using only the defaults.
- setDestinationFileName(String) - Method in class org.apache.pdfbox.util.PDFMergerUtility
-
Set the name of the destination file.
- setDestinationStream(OutputStream) - Method in class org.apache.pdfbox.util.PDFMergerUtility
-
Set the destination OutputStream.
- setDests(PDDestinationNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Set the named destinations that are associated with this document.
- setDifferences(COSStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the differences stream.
- setDirect(boolean) - Method in class org.apache.pdfbox.cos.COSBase
-
Set the state true, if the dictionary should be written as a direct object and not indirect.
- setDirectory(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Set the dir to launch from.
- setDisplayDocTitle(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the display doc title preference.
- setDistances(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the distances.
- setDocument(COSDocument) - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
Set the document for this stream.
- setDocument(PDDocument) - Method in class org.apache.pdfbox.pdfviewer.PDFTreeModel
-
Set the document to display in the tree.
- setDocumentID(COSArray) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will set the document ID.
- setDocumentInformation(PDDocumentInformation) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will set the document information for this document.
- setDocumentOutline(PDDocumentOutline) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the document outlines.
- setDomain(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
Sets the optional Domain entry for the function based shading.
- setDomain(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
Sets the optional Domain entry for this shading.
- setDomainValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will set the domain values.
- setDoNotScroll(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the doNotScroll bit.
- setDoNotSpellCheck(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the doNotSpellCheck bit.
- setDownAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set a list of appearances.
- setDownAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set the down appearance when there is down appearance
to be shown.
- setDP(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will set a JavaScript action to be performed
after printing a document.
- setDropThreshold(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
sets the minimum whitespace, as a multiple
of the max height of the current characters
beyond which the current line start is considered
to be a paragraph start.
- setDS(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will set a JavaScript action to be performed
after saving a document.
- setDuplex(PDViewerPreferences.DUPLEX) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the Duplex preference.
- setE(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the cursor
enters the annotation's active area.
- setElementIdentifier(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the element identifier (ID).
- setEmbeddedDate(String, String, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Set the value of a date entry in the dictionary.
- setEmbeddedDate(String, COSName, Calendar) - Method in class org.apache.pdfbox.cos.COSDictionary
-
Set the date object.
- setEmbeddedFDFs(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the list of embedded FDFs.
- setEmbeddedFile(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Set the embedded file for this spec.
- setEmbeddedFileDos(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Set the embedded dos file for this spec.
- setEmbeddedFileMac(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Set the embedded Mac file for this spec.
- setEmbeddedFiles(PDEmbeddedFilesNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Set the named embedded files that are associated with this document.
- setEmbeddedFileUnix(PDEmbeddedFile) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
Set the embedded Unix file for this spec.
- setEmbeddedInt(String, String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setEmbeddedInt(String, COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setEmbeddedString(String, String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSString
object.
- setEmbeddedString(String, COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSString
object.
- setEncodeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunctionType0
-
This will set the encode values.
- setEncoding(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the encoding.
- setEncoding(COSBase) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Set the encoding object from the fonts dictionary.
- setEncryptionDictionary(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will set the encryption dictionary, this should only be called when
encrypting the document.
- setEncryptionDictionary(PDEncryptionDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will set the encryption dictionary for this document.
- setEncryptionKeyLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.ProtectionPolicy
-
set the length in (bits) of the secret key that will be
used to encrypt document data.
- setEndBookmark(PDOutlineItem) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the bookmark where the text extraction should stop.
- setEndColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Sets the colour for the end edge.
- setEndIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance from the end edge of the BLSE to that of the reference
area in the inline-progression direction (EndIndent).
- setEndIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance from the end edge of the BLSE to that of the reference
area in the inline-progression direction (EndIndent).
- setEndPage(int) - Method in class org.apache.pdfbox.util.PageExtractor
-
Sets the last page number to be extracted.
- setEndPage(int) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will set the last page to be extracted by this class.
- setEndPage(int) - Method in class org.apache.pdfbox.util.Splitter
-
This will set the end page.
- setEndPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the line ending style for the end point,
see the LE_ constants for the possible values.
- setEOFLookupRange(int) - Method in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
Sets how many trailing bytes of PDF file are searched for
EOF marker and 'startxref' marker.
- setExecuteParam(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Set the parameter to pass the executable.
- setExpandedForm(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the expanded form (E).
- setExpectedLength(COSBase) - Method in class org.apache.pdfbox.io.RandomAccessFileOutputStream
-
This will set the expected length of this stream.
- setExtend(COSArray) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
Sets the optional Extend entry for this shading.
- setExtendedGraphicsState(PDExtendedGraphicsState) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will set the extended graphics state for this pattern.
- setExtends(PDObjectStream) - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
A reference to an object stream, of which the current object stream is
considered an extension.
- setExternalData(PDExternalDataDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the external data dictionary.
- setF(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAdditionalActions
-
Set the F action.
- setF(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will set a JavaScript action to be performed before
the field is formatted to display its current value.
- setF(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set the file name to be launched or the document to be opened
or printed, in standard Windows pathname format.
- setFD(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the value indication if the denominator of the fractional value is reduced/truncated .
- setFDF(FDFDictionary) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will set the FDF document.
- setFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will set the flags for this field.
- setFields(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the list of fields.
- setFields(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
This will set a list of fields for this template.
- setFields(List) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Set the fields that are part of this AcroForm.
- setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will set the file name.
- setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
-
This will set the file name.
- setFile(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDSimpleFileSpecification
-
This will set the file name.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Set the file specification.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Set the file specification.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the file specification.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set the application to be launched or the document
to be opened or printed.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will set the file in which the destination is located.
- setFile(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
Set the attached file.
- setFileDecodeParams(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will set the list of decode params.
- setFileDecodeParams(List) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will set the list of decode params.
- setFileDos(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will set name representing a dos file.
- setFileFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will set the filters that are part of this stream.
- setFileFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will set the filters that are part of this stream.
- setFileMac(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will set name representing a Mac file.
- setFilename(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Set the file to launch.
- setFileSelect(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the file select bit.
- setFileSpecification(PDFileSpecification) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
This will set the file specification for this named page reference.
- setFileUnix(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
-
This will set name representing a Unix file.
- setFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Sets the filter entry of the encryption dictionary.
- setFilter(String) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
Sets the filter entry of the encryption dictionary.
- setFilter(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setFilters(COSBase) - Method in class org.apache.pdfbox.cos.COSStream
-
set the filters to be applied to the stream.
- setFilters(COSBase) - Method in class org.apache.pdfbox.pdmodel.common.COSStreamArray
-
set the filters to be applied to the stream.
- setFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
This will set the filters that are part of this stream.
- setFilters(List) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
This will set the filters that are part of this stream.
- setFilters(List) - Method in class org.apache.pdfbox.util.ImageParameters
-
This will set the filters that are part of this stream.
- setFirstBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
This will set the first bead in the thread.
- setFirstByteOffset(int) - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
The byte offset (in the decoded stream) of the first compressed object.
- setFirstChar(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Set the first character this font supports.
- setFirstChild(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Set the first child, this will be maintained by this class.
- setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitDestination
-
Set if this page destination should just fit the bounding box.
- setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
-
Set if this page destination should just fit the bounding box.
- setFitBoundingBox(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
-
Set if this page destination should just fit the bounding box.
- setFitWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the fit window preference.
- setFixedPitch(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setFlag(COSDictionary, String, int, boolean) - Static method in class org.apache.pdfbox.util.BitFlagHelper
-
- setFlag(COSDictionary, COSName, int, boolean) - Static method in class org.apache.pdfbox.util.BitFlagHelper
-
Sets the given boolean value at bitPos in the flags.
- setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the font flags.
- setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the font flags.
- setFlags(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the font flags.
- setFlatness(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the flatness property.
- setFlatnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the flatness tolerance.
- setFloat(String, float) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSFloat
object.
- setFloat(COSName, float) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSFloat
object.
- setFloatArray(float[]) - Method in class org.apache.pdfbox.cos.COSArray
-
Clear the current contents of the COSArray and set it with the float[].
- setFo(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the annotation
receives the input focus.
- setFont(PDFont, float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the font to draw text with.
- setFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
This will set the font for this font setting.
- setFont(PDFont) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the font.
- setFont(PDSimpleFont) - Method in class org.apache.pdfbox.TextToPDF
-
- setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
Set the fonts bounding box.
- setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
Set the fonts bounding box.
- setFontBoundingBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Set the fonts bounding box.
- setFontDescriptor(PDFontDescriptorDictionary) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
This will set the font descriptor.
- setFontEncoding(Encoding) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
The will set the encoding for this font.
- setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the font family.
- setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the font family.
- setFontFamily(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the font family.
- setFontFile(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Set the type 1 font program.
- setFontFile2(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Set the true type font program.
- setFontFile3(PDStream) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Set a stream containing a font program that is not true type or type 1.
- setFontMatrix(PDMatrix) - Method in class org.apache.pdfbox.pdmodel.font.PDType3Font
-
Set the font matrix for this type3 font.
- setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the font name.
- setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the font name.
- setFontName(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the font name.
- setFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of fonts.
- setFonts(Map<String, PDFont>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- setFontSetting(PDFontSetting) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the font setting for this graphics state.
- setFontSize(float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDFontSetting
-
This will set the size of the font.
- setFontSize(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the fontSize.
- setFontSize(int) - Method in class org.apache.pdfbox.TextToPDF
-
- setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the font stretch.
- setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the font stretch.
- setFontStretch(String) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the font stretch.
- setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
Set the weight of the font.
- setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
Set the weight of the font.
- setFontWeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
Set the weight of the font.
- setForceBold(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setForceHexForm(boolean) - Method in class org.apache.pdfbox.cos.COSString
-
Forces the string to be written in hexadecimal form instead of literal form.
- setForceLiteralForm(boolean) - Method in class org.apache.pdfbox.cos.COSString
-
Forces the string to be written in literal form instead of hexadecimal form.
- setForceParsing(boolean) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
Enable/Disable force parsing.
- setFormattedValue(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Sets the string for the property value.
- setFormType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
Set the form type.
- setFourColors(String, PDFourColours) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets four colours.
- setFractionalDisplay(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the value for the manner to display a fractional value.
- setFractionalSpaceToAllocate(PDRange) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will set frational space to allocate.
- setFree(boolean) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
This will set the free attribute.
- setFromAffineTransform(AffineTransform) - Method in class org.apache.pdfbox.util.Matrix
-
Set the values of the matrix from the AffineTransform.
- setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
This will set the function for the color conversion.
- setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType2
-
This will set the function for the color conversion.
- setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType4
-
This will set the function for the color conversion.
- setFunction(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
This will set the function for the color conversion.
- setG(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will set the g value of the tristimulus.
- setGamma(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
Set the gamma value.
- setGamma(PDGamma) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
Set the gamma value.
- setGeneration(long) - Method in class org.apache.pdfbox.cos.COSUnread
-
- setGeneration(long) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
-
This will set the objects generation number.
- setGenerationNumber(COSInteger) - Method in class org.apache.pdfbox.cos.COSObject
-
Setter for property generationNumber.
- setGlyphOrientationVertical(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the orientation of glyphs when the inline-progression direction is
top to bottom or bottom to top (GlyphOrientationVertical).
- setGraphicsStack(Stack<PDGraphicsState>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- setGraphicsState(PDGraphicsState) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- SetGraphicsStateParameters - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetGraphicsStateParameters() - Constructor for class org.apache.pdfbox.util.operator.SetGraphicsStateParameters
-
- setGraphicsStates(Map<String, PDExtendedGraphicsState>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of graphics states.
- setGraphicsStates(Map<String, PDExtendedGraphicsState>) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- setGroupEnabled(String, boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentProperties
-
Enables or disables an optional content group.
- setGuideLineColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Set the color space instance for this box style.
- setGuidelineStyle(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Set the style for the box.
- setGuidelineWidth(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Set the guideline width.
- setHangingIndent() - Method in class org.apache.pdfbox.util.PositionWrapper
-
Sets the isHangingIndent() flag to true.
- setHasToUnicode(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Sets hasToUnicode to the given value.
- setHeaders(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the headers (Headers).
- setHeaders(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Sets the headers (Headers).
- setHeaderString(String) - Method in class org.apache.pdfbox.cos.COSDocument
-
- setHeight(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the height of the element???s content rectangle in the
block-progression direction (Height).
- setHeight(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the height of the element???s content rectangle in the
block-progression direction (Height).
- setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
- setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- setHeight(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Set the height of the image.
- setHeight(int) - Method in class org.apache.pdfbox.util.ImageParameters
-
Set the height of the image.
- setHeightAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
- setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Specifies whether the property shall be hidden.
- setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the hidden flag.
- setHidden(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the hidden flag.
- setHideMenubar(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the menubar preference.
- setHideToolbar(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the toolbar preference.
- setHideWindowUI(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the window UI preference.
- setHighlightingMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
Sets the highlighting mode.
- setHighlightMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
Set the highlight mode.
- setHighValue(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will set the highest value that is allowed.
- setHorizontalScalingPercent(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the horizontalScaling.
- SetHorizontalTextScaling - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetHorizontalTextScaling() - Constructor for class org.apache.pdfbox.util.operator.SetHorizontalTextScaling
-
- setIccOverrideColor(Color) - Static method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
- setIconFit(FDFIconFit) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the icon fit entry.
- setID(COSArray) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the FDF id.
- setIDTree(PDNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Sets the ID tree.
- setIgnoreAcroFormErrors(boolean) - Method in class org.apache.pdfbox.util.PDFMergerUtility
-
- setImageData(byte[]) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
-
Set the bytes that make up the image.
- setImageData(byte[]) - Method in class org.apache.pdfbox.util.PDFOperator
-
This will set the image data, this is only used for the ID operator.
- setImageParameters(ImageParameters) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDInlinedImage
-
This will set the image parameters for this image.
- setImageParameters(ImageParameters) - Method in class org.apache.pdfbox.util.PDFOperator
-
This will set the image parameters, this is only valid for BI operators.
- setIndentThreshold(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
sets the multiple of whitespace character widths
for the current text which the current
line start can be indented from the previous line start
beyond which the current line start is considered
to be a paragraph start.
- setIndex(int) - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
-
This will set the index value.
- 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).
- setInReplyTo(PDAnnotation) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the annotation to which this one is "In Reply To" the
actual relationship is specified by the RT entry.
- setInt(int, int) - Method in class org.apache.pdfbox.cos.COSArray
-
Set the value in the array as an integer.
- setInt(String, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setInt(COSName, int) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setInteger(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets an integer.
- setIntensity(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
This will set the intensity of the applied effect.
- setIntent(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the intent of the annotation The values and meanings are
specific to the actual annotation See the IT_* constants for the
annotation classes.
- setInteriorColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set interior colour of the line endings defined in the LE
entry.
- setInteriorColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will set interior colour of the drawn area
Colour is in DeviceRGB colourspace.
- setInvisible(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the invisible flag.
- setInvisible(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the invisible flag.
- setIsFontSubstituted(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
- setItalic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setItalic(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the italic property of the text.
- setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the italic angle for the font.
- setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the italic angle for the font.
- setItalicAngle(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the italic angle for the font.
- setItem(COSName, COSBase) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setItem(COSName, COSObjectable) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setItem(String, COSObjectable) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setItem(String, COSBase) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will set an item in the dictionary.
- setJavaScript(FDFJavaScript) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the JavaScript entry.
- setJavascript(PDJavascriptNameTreeNode) - Method in class org.apache.pdfbox.pdmodel.PDDocumentNameDictionary
-
Set the named javascript entries that are associated with this document.
- setK(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will set a JavaScript action to be performed when the user
types a keystroke into a text field or combo box or modifies the
selection in a scrollable list box.
- setKey(byte[]) - Method in class org.apache.pdfbox.encryption.ARCFour
-
This will reset the key to be used.
- setKey(Object) - Method in class org.apache.pdfbox.pdfviewer.MapEntry
-
This will set the key for this entry.
- setKeyLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.SecurityHandler
-
Setter of the property keyLength.
- setKeywords(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the keywords of the document.
- setKids(List) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Set the children of this named tree.
- setKids(List) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Set the children of this number tree.
- setKids(List<Object>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode
-
Sets the kids (K).
- setKids(List<FDFField>) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the list of kids.
- setKids(List<COSObjectable>) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will set the list of kids.
- setKnockoutFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the knockout.
- setLabelItem(int, PDPageLabelRange) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabels
-
Sets the page label range beginning at the specified start page.
- setLabelPositionToValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the value indicating the ordering of the label specified by U to the calculated unit value.
- setLabelPrefixString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the text to be concatenated to the left of the label specified by U.
- setLabelSuffixString(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the text to be concatenated after the label specified by U.
- setLanguage(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the language (Lang).
- setLanguage(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the Language for the document.
- setLastChar(int) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Set the last character this font supports.
- setLastChild(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Set the last child, this will be maintained by this class.
- setLeaderLineExtensionLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the length of the leader line extensions.
- setLeaderLineLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the length of the leader line.
- setLeaderLineOffsetLength(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the length of the leader line offset.
- setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the leading for the font.
- setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the leading for the font.
- setLeading(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the leading for the font.
- setLeading(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the leading.
- setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitHeightDestination
-
Set the left x-coordinate, a value of -1 implies that the current x-coordinate
will be used.
- setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Set the left x-coordinate, a value of -1 implies that the current x-coordinate
will be used.
- setLeft(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Set the left x-coordinate, a value of -1 implies that the current x-coordinate
will be used.
- setLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDCryptFilterDictionary
-
This will set the number of bits to use for the crypt filter algorithm.
- setLength(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the number of bits to use for the encryption algorithm.
- setLength(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will set the length of the content stream.
- setLength(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the length of the content stream.
- setLine(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set start and end coordinates of the line (or leader line if LL
entry is set).
- setLinearInterpretation(PDMatrix) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will set the linear interpretation matrix.
- setLineCap(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the line cap.
- setLineCapStyle(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the line cap style.
- setLineCapStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the line cap style for the graphics state.
- SetLineCapStyle - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- SetLineCapStyle() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineCapStyle
-
- SetLineCapStyle - Class in org.apache.pdfbox.util.operator
-
Implementation of content stream operator for page drawer.
- SetLineCapStyle() - Constructor for class org.apache.pdfbox.util.operator.SetLineCapStyle
-
- setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.prepress.PDBoxStyle
-
Set the line dash pattern associated with this box style.
- setLineDashPattern(float[], float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the line dash pattern.
- setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the dash pattern for the graphics state.
- setLineDashPattern(PDLineDashPattern) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will set the current line dash pattern.
- SetLineDashPattern - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- SetLineDashPattern() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineDashPattern
-
- SetLineDashPattern - Class in org.apache.pdfbox.util.operator
-
Implementation of content stream operator for page drawer.
- SetLineDashPattern() - Constructor for class org.apache.pdfbox.util.operator.SetLineDashPattern
-
- setLineHeight(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the element???s preferred height in the block-progression direction
(LineHeight).
- setLineHeight(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the element???s preferred height in the block-progression direction
(LineHeight).
- setLineHeightAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
- setLineHeightNormal() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
- setLineJoin(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
Get the value of the line join.
- setLineJoinStyle(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the line join style.
- setLineJoinStyle(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the line join style.
- SetLineJoinStyle - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- SetLineJoinStyle() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineJoinStyle
-
- SetLineJoinStyle - Class in org.apache.pdfbox.util.operator
-
Implementation of content stream operator for page drawer.
- SetLineJoinStyle() - Constructor for class org.apache.pdfbox.util.operator.SetLineJoinStyle
-
- setLineLength(int) - Method in class org.apache.pdfbox.io.ASCII85OutputStream
-
This will set the line length that will be used.
- SetLineMiterLimit - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- SetLineMiterLimit() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineMiterLimit
-
- SetLineMiterLimit - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetLineMiterLimit() - Constructor for class org.apache.pdfbox.util.operator.SetLineMiterLimit
-
- setLinePath(GeneralPath) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Set the line path to draw.
- setLineSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the desired line separator for output text.
- setLineSloaps(PDNumberFormatDictionary[]) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the sloaps of a line.
- setLineStart() - Method in class org.apache.pdfbox.util.PositionWrapper
-
Sets the isLineStart() flag to true.
- setLineWidth(float) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set linewidth to the given value.
- setLineWidth(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the line width.
- setLineWidth(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the line width.
- SetLineWidth - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- SetLineWidth() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SetLineWidth
-
- SetLineWidth - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetLineWidth() - Constructor for class org.apache.pdfbox.util.operator.SetLineWidth
-
- setListItemPatterns(List<Pattern>) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
use to supply a different set of regular expression
patterns for matching list item starts.
- setListNumbering(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the list numbering (ListNumbering).
- setListNumbering(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDListAttributeObject
-
Sets the list numbering (ListNumbering).
- setLocation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setLocked(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the locked flag.
- setLocked(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the locked flag.
- setLong(String, long) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setLong(COSName, long) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSInteger
object.
- setLookupColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDIndexed
-
This will set a color in the color lookup table.
- setLowerLeftX(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will set the lower left x coordinate.
- setLowerLeftY(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will set the lower left y coordinate.
- setMacCreator(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the mac Creator.
- setMacResFork(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the mac ResFork.
- setMacSubtype(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the mac subtype.
- setMarked(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Set if this is a tagged PDF.
- setMarkInfo(PDMarkInfo) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set information about the doc's usage of tagged features.
- setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
Sets the optional Matrix entry for the Pattern.
- setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
Sets the optional Matrix entry for the Pattern.
- setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType1
-
Sets the optional Matrix entry for the function based shading.
- setMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
Sets the optional Matrix entry for the form XObject.
- SetMatrix - Class in org.apache.pdfbox.util.operator
-
- SetMatrix() - Constructor for class org.apache.pdfbox.util.operator.SetMatrix
-
- setMax(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
This will set the maximum value for the range.
- setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the max width for the font.
- setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the max width for the font.
- setMaxWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the max width for the font.
- setMCID(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Sets the marked content identifier.
- setMeasure(PDMeasureDictionary) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will set the measure dictionary.
- setMediaBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the mediaBox for this page.
- setMediaBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will set the mediaBox for this page.
- setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDMemoryStream
-
Set the metadata for this object.
- setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.common.PDStream
-
Set the metadata for this object.
- setMetadata(COSStream) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will set the metadata stream that is associated with this color space.
- setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObject
-
Set the metadata for this object.
- setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the metadata for this object.
- setMetadata(PDMetadata) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
Set the metadata for this object.
- setMin(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRange
-
This will set the minimum value for the range.
- setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the missing width for the font.
- setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the missing width for the font.
- setMissingWidth(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the missing width for the font.
- setMiterLimit(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the miter limit for the graphics state.
- setMiterLimit(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the miter limit.
- setModDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the mod date.
- setModificationDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the modification date of the document.
- setModifiedDate(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the the date and time the annotation was modified.
- SetMoveAndShow - Class in org.apache.pdfbox.util.operator
-
- SetMoveAndShow() - Constructor for class org.apache.pdfbox.util.operator.SetMoveAndShow
-
- setMultiline(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the multiline bit.
- setName(int, String) - Method in class org.apache.pdfbox.cos.COSArray
-
Set the value in the array as a name.
- setName(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSName
object.
- setName(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSName
object.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
This will set the name of the named text stream.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Sets the property name.
- setName(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets a name value.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set a unique name for an annotation.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFNamedPageReference
-
This will set the name of the referenced page.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.graphics.optionalcontent.PDOptionalContentGroup
-
Sets the name of the optional content group.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
This will set the name (and hence appearance, AP taking precedence)
For this annotation.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will set the name (and hence appearance, AP taking precedence) For
this annotation.
- setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDViewportDictionary
-
This will set the name of the viewport.
- setNamedDestination(String) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDNamedDestination
-
Set the named destination.
- setNamedJavaScripts(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFJavaScript
-
This should be a list of PDNamedTextStream objects.
- setNames(Map<String, ? extends COSObjectable>) - Method in class org.apache.pdfbox.pdmodel.common.PDNameTreeNode
-
Set the names of for this node.
- setNames(PDDocumentNameDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the names dictionary for the document.
- setNeedToBeUpdate(boolean) - Method in class org.apache.pdfbox.cos.COSBase
-
- setNext(List) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will set the next action, or sequence of actions, to be performed after this one.
- setNextBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Set the next bead in the thread.
- setNextSibling(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the next sibling, this will be maintained by this class.
- setNoExport(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
sets the field to be not exported..
- setNonFullScreenPageMode(PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the non full screen page mode preference.
- setNonFullScreenPageMode(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setNonStrokeAlphaConstants(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the non-stroke alpha constants property.
- setNonStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the non stroking alpha constant.
- SetNonStrokingCalRGBColor - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingCalRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingCalRGBColor
-
- SetNonStrokingCMYKColor - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingCMYKColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingCMYKColor
-
- setNonStrokingColor(Color) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as RGB.
- setNonStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the color components of current non stroking colorspace.
- setNonStrokingColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as RGB, 0-255.
- setNonStrokingColor(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as CMYK, 0-255.
- setNonStrokingColor(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as CMYK, 0.0-1.0.
- setNonStrokingColor(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as grayscale, 0-255.
- setNonStrokingColor(double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the non stroking color, specified as Grayscale 0.0-1.0.
- SetNonStrokingColor - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingColor
-
- setNonStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color space.
- SetNonStrokingColorSpace - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingColorSpace() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingColorSpace
-
- SetNonStrokingDeviceN - Class in org.apache.pdfbox.util.operator
-
- SetNonStrokingDeviceN() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingDeviceN
-
- SetNonStrokingGrayColor - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingGrayColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingGrayColor
-
- SetNonStrokingICCBasedColor - Class in org.apache.pdfbox.util.operator
-
- SetNonStrokingICCBasedColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingICCBasedColor
-
- setNonStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint control(OP).
- SetNonStrokingPattern - Class in org.apache.pdfbox.util.operator
-
Set the non stroking pattern.
- SetNonStrokingPattern() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingPattern
-
- SetNonStrokingRGBColor - Class in org.apache.pdfbox.util.operator
-
Set the non stroking color space.
- SetNonStrokingRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingRGBColor
-
- SetNonStrokingSeparation - Class in org.apache.pdfbox.util.operator
-
- SetNonStrokingSeparation() - Constructor for class org.apache.pdfbox.util.operator.SetNonStrokingSeparation
-
- setNonSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setNormalAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set a list of appearances.
- setNormalAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set the normal appearance when there is only one appearance
to be shown.
- setNormalCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the normal caption.
- setNoRotate(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the noRotate flag.
- setNoRotate(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the noRotate flag.
- setNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the noView flag.
- setNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the noView flag.
- setNoZoom(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the noZoom flag.
- setNoZoom(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the noZoom flag.
- setNumber(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will set the current object number.
- setNumber(String, float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets a float number.
- setNumber(String, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets an integer number.
- setNumber(long) - Method in class org.apache.pdfbox.persistence.util.COSObjectKey
-
This will set the objects id.
- setNumberOfComponents(int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will set the number of color components.
- setNumberOfObjects(int) - Method in class org.apache.pdfbox.pdmodel.common.PDObjectStream
-
Set the number of objects.
- setNumbers(Map<Integer, Object>) - Method in class org.apache.pdfbox.pdmodel.common.PDNumberTreeNode
-
Set the names of for this node.
- setO(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDPageAdditionalActions
-
This will set an action to be performed when the page
is opened.
- setO(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set the string specifying the operation to perform:
open to open a document
print to print a document
If the F entry designates an application instead of a document, this entry
is ignored and the application is launched.
- setObject(COSBase) - Method in class org.apache.pdfbox.cos.COSObject
-
This will set the object that this object encapsulates.
- setObjectNumber(COSInteger) - Method in class org.apache.pdfbox.cos.COSObject
-
Setter for property objectNumber.
- setObjectNumber(long) - Method in class org.apache.pdfbox.cos.COSUnread
-
- setOCProperties(PDOptionalContentProperties) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the optional content properties dictionary.
- setOffset(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriterXRefEntry
-
The offset attribute.
- setOnNewLine(boolean) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
-
This will set a flag telling if we are on a newline.
- setOpacity(float) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the annotation opacity.
- setOpen(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
This will set inital state of the annotation, open or closed.
- setOpen(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will set initial state of the annotation, open or closed.
- setOpenAction(PDDestinationOrAction) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the Document Open Action for this object.
- setOpenCount(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Set the open count.
- setOpenInNewWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will specify the destination document to open in a new window.
- setOpenInNewWindow(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will specify the destination document to open in a new window.
- setOperation(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDWindowsLaunchParams
-
Set the operation to perform..
- setOption(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFOptionElement
-
This will set the string for an available option.
- setOptions(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the options for the choice field.
- setOptions(List) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceButton
-
This will will set the list of options for this button.
- setOverprint(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the overprint property.
- setOverprintMode(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint mode(OPM).
- setOverprintMode(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the overprint mode property.
- setOwner(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Sets the owner of the attributes.
- setOwnerKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the O entry in the standard encryption dictionary.
- setOwnerKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will set the O entry in the standard encryption dictionary.
- setOwnerPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Setter of the property ownerPassword.
- setP(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set a parameter string to be passed to the application designated by the F entry.
- setPaddings(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the paddings for four sides separately (Padding).
- setPage(PDPage) - Method in class org.apache.pdfbox.pdfviewer.PDFPagePanel
-
This will set the page that should be displayed in this panel.
- setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference
-
Sets the page.
- setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the page on which some or all of the content items designated by
the K entry shall be rendered (Pg).
- setPage(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
This will set the page.
- setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the corresponding page for this annotation.
- setPage(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Set the page number.
- setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Set the page for this destination.
- setPage(PDPage) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Set the page that this bead is part of.
- setPageBreak() - Method in class org.apache.pdfbox.util.PositionWrapper
-
Sets the isPageBreak() flag to true.
- setPageEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the end of a page.
- setPageInfo(FDFPageInfo) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
This will set the page info.
- setPageLabels(PDPageLabels) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the page label descriptor for the document.
- setPageLayout(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the page layout.
- setPageMode(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the page mode.
- setPageNumber(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
-
Set the page number for this destination.
- setPages(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the list of pages.
- setPageSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the desired page separator for output text.
- setPageStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the beginning of a page.
- setPaintType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will set the paint type.
- setPaintType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the paint type.
- setParagraphEnd(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the end of a paragraph.
- setParagraphStart(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Sets the string which will be used at the beginning of a paragraph.
- setParagraphStart() - Method in class org.apache.pdfbox.util.PositionWrapper
-
sets the isParagraphStart() flag to true.
- setParent(PDStructureNode) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the parent in the structure hierarchy (P).
- setParent(PDAnnotationMarkup) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
This will set the markup annotation which this popup relates to.
- setParent(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineNode
-
Set the parent of this object, this is maintained by these objects and should not
be called by any clients of PDFBox code.
- setParent(PDField) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
Set the parent of this field.
- setParent(PDPageNode) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the parent of this page.
- setParent(PDPageNode) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will set the parent of this page.
- setParser(ConformingPDFParser) - Method in class org.apache.pdfbox.cos.COSUnread
-
- setParser(ConformingPDFParser) - Method in class org.apache.pdfbox.pdmodel.ConformingPDDocument
-
- setPartialFieldName(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the partial field name.
- setPartialName(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
This will set the partial name of the field.
- setPassword(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the password bit.
- setPattern(PDPatternResources) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDColorState
-
This will update the current pattern.
- setPatterns(Map<String, PDPatternResources>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of patterns.
- setPatternType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
This will set the pattern type.
- setPC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the page containing
the annotation is closed.
- setPermission(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
-
Set the access permission granted to the recipient.
- setPermissions(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the permissions bit mask.
- setPermissions(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will set the permissions bit mask.
- setPermissions(AccessPermission) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Setter of the property permissions.
- setPhaseStart(int) - Method in class org.apache.pdfbox.pdmodel.graphics.PDLineDashPattern
-
This will set the line dash pattern phase.
- setPI(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the page containing the annotation
is no longer visible in the viewer application's user interface.
- setPlacement(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the positioning of the element with respect to the enclosing
reference area and other content (Placement).
- setPO(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the page containing
the annotation is opened.
- setPopup(PDAnnotationPopup) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the popup annotation used for entering/editing the text for
this annotation.
- setPos(long) - Method in class org.apache.pdfbox.pdfwriter.COSStandardOutputStream
-
This will get the current position in the stream.
- setPreferedSignatureSize(int) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Set the preferred size of the signature.
- setPrefix(String) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Sets the page label prefix for this page range.
- setPreviousBead(PDThreadBead) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Set the previous bead in the thread.
- setPreviousSibling(PDOutlineNode) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the previous sibling, this will be maintained by this class.
- setPreviousURI(PDActionURI) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will set the previous URI action, in case it
needs to be retrieved at later date.
- setPrintArea(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setPrintArea(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the PrintArea preference.
- setPrintClip(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setPrintClip(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the PrintClip preference.
- setPrinted(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the printed flag.
- setPrinted(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the printed flag.
- setPrintScaling(PDViewerPreferences.PRINT_SCALING) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the PrintScaling preference.
- setProducer(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the producer of the document.
- setProperties(PDPropertyList) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
Sets the dictionary mapping resource names to property list dictionaries for marked
content.
- setPV(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the page containing
the annotation becomes visible in the viewer application's user interface.
- setQ(int) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
This will set the quadding/justification of the text.
- setQuadPoints(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
This will set the set of quadpoints which encompass the areas of this
annotation which will activate.
- setQuadPoints(float[]) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
This will set the set of quadpoints which encompass the areas of this
annotation.
- setR(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDGamma
-
This will set the r value of the tristimulus.
- setRadiosInUnison(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
-
From the PDF Spec
If set, a group of radio buttons within a radio button field that
use the same value for the on state will turn on and off in unison; that is if
one is checked, they are all checked.
- setRangeForComponent(PDRange, int) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDICCBased
-
This will set the a range for this color space.
- setRangeValues(COSArray) - Method in class org.apache.pdfbox.pdmodel.common.function.PDFunction
-
This will set the range values.
- setReadingDirection(PDViewerPreferences.READING_DIRECTION) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the reading direction preference.
- setReadingDirection(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setReadOnly() - Method in class org.apache.pdfbox.pdmodel.encryption.AccessPermission
-
Locks the access permission read only (ie, the setters will have no effects).
- setReadOnly(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the readOnly flag.
- setReadOnly(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the readOnly flag.
- setReadonly(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
sets the field to be read-only.
- setReason(String) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setRecipients(byte[][]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the Recipients field of the dictionary.
- setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the rectangle associated with this annotation.
- setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
This will set the rectangle for this annotation.
- setRectangle(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Set the rectangle on the page that this bead covers.
- setRectDifference(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will set the rectangle difference rectangle.
- setRecursivlyRead(boolean) - Method in class org.apache.pdfbox.pdfparser.ConformingPDFParser
-
- setReferencedObject(PDAnnotation) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Sets the referenced annotation.
- setReferencedObject(PDXObject) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDObjectReference
-
Sets the referenced XObject.
- setRename(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
This will set if the fields can be renamed.
- setRenderingIntent(String) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will set the rendering intent for the graphics state.
- setRenderingIntent(String) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will set the rendering intent.
- setRenderingMode(int) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the renderingMode.
- setReplyType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the Reply Type (relationship) with the annotation in the
IRT entry See the RT_* constants for the available values.
- setRequired(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
sets the field to be required.
- setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the resources for this pattern.
- setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
This will set the resources for this page.
- setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream
-
This will set the new resources.
- setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the resources for this page.
- setResources(PDResources) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will set the resources for this page.
- setRevision(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the R entry of the encryption dictionary.
- setRevision(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will set the R entry of the encryption dictionary.
- setRevisionNumber(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the revision number (R).
- setRevisionNumber(T, int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
-
Sets the revision number of a specified object.
- setRichContents(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the rich text stream which is displayed in the popup window.
- setRichText(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will set the rich text value.
- setRichText(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
Set the richText bit.
- setRight(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Set the right x-coordinate, a value of -1 implies that the current x-coordinate
will be used.
- setRise(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the rise.
- setRole(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDPrintFieldAttributeObject
-
Sets the role.
- setRoleMap(Map<String, String>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot
-
Sets the role map.
- setRolloverAppearance(Map<String, PDAppearanceStream>) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set a list of appearances.
- setRolloverAppearance(PDAppearanceStream) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary
-
This will set the rollover appearance when there is rollover appearance
to be shown.
- setRolloverCaption(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the rollover caption.
- setRotation(int) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary
-
This will set the rotation.
- setRotation(int) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the rotation for this page.
- setRotation(int) - Method in class org.apache.pdfbox.pdmodel.PDPageNode
-
This will set the rotation for this page.
- setRowSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the number of rows in the enclosing table that shall be spanned by
the cell (RowSpan).
- setRowSpan(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Sets the number of rows in the enclosing table that shall be spanned by
the cell (RowSpan).
- setRubyAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the justification of the lines within a ruby assembly (RubyAlign).
- setRubyPosition(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the placement of the RT structure element relative to the RB element
in a ruby assembly (RubyPosition).
- setS(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will set the type of action that the actions dictionary describes.
- setS(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will set the type of action that the actions dictionary describes.
- setScaleOption(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will set the scale option for the icon.
- setScaleRatio(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
This will set the scale ration.
- setScaleToFitAnnotation(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will tell the icon to scale.
- setScaleType(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will set the scale type.
- setScope(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the scope (Scope).
- setScope(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Sets the scope (Scope).
- setScript(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setSecurityHandler(SecurityHandler) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
Sets security handler if none is set already.
- setSerif(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setSetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setSetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setSetWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the widget field flags that are associated with this field.
- setSetWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the widget field flags that are associated with this field.
- setShading(PDShadingResources) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDShadingPatternResources
-
This will set the shading resources for this pattern.
- setShadings(Map<String, PDShadingResources>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of shadings.
- setShadingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
This will set the shading type.
- setShouldSeparateByBeads(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set if the text stripper should group the text output by a list of beads.
- setSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will set the signature that is associated with this catalog.
- setSignature(PDSignature) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
Add a signature dictionary to the signature field
- setSignatureInterface(SignatureInterface) - Method in class org.apache.pdfbox.cos.COSDocument
-
Set the signature interface to the given value.
- setSignDate(Calendar) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
- setSize(int) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the size of the embedded file.
- setSmallCap(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setSmoothness(double) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the smoothness property.
- setSmoothnessTolerance(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the smoothness tolerance.
- setSortByPosition(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
The order of the text tokens in a PDF file may not be in the same
as they appear visually on the screen.
- setSpaceAfter(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the amount of extra space following the after edge of the BLSE in
the block-progression direction (SpaceAfter).
- setSpaceAfter(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the amount of extra space following the after edge of the BLSE in
the block-progression direction (SpaceAfter).
- setSpaceBefore(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the amount of extra space preceding the before edge of the BLSE in
the block-progression direction (SpaceBefore).
- setSpaceBefore(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the amount of extra space preceding the before edge of the BLSE in
the block-progression direction (SpaceBefore).
- setSpacingTolerance(float) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the space width-based tolerance value that is used
to estimate where spaces in text should be added.
- setSplitAtPage(int) - Method in class org.apache.pdfbox.util.Splitter
-
This will tell the splitting algorithm where to split the pages.
- setStart(int) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Sets the start value for page numbering in this page range.
- setStartBookmark(PDOutlineItem) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the bookmark where text extraction should start, inclusive.
- setStartColour(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDFourColours
-
Sets the colour for the start edge.
- setStartIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance from the start edge of the reference area to that of
the BLSE in the inline-progression direction (StartIndent).
- setStartIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the distance from the start edge of the reference area to that of
the BLSE in the inline-progression direction (StartIndent).
- setStartPage(int) - Method in class org.apache.pdfbox.util.PageExtractor
-
Sets the first page number to be extracted.
- setStartPage(int) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This will set the first page to be extracted by this class.
- setStartPage(int) - Method in class org.apache.pdfbox.util.Splitter
-
This will set the start page.
- setStartPointEndingStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
This will set the line ending style for the start point,
see the LE_ constants for the possible values.
- setStartXref(long) - Method in class org.apache.pdfbox.cos.COSDocument
-
This method set the startxref value of the document.
- setStartxref(long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Sets the byte position of the first XRef
(has to be called after very last startxref was read).
- setStartxref(long) - Method in class org.apache.pdfbox.pdfwriter.COSWriter
-
This will set the start xref.
- setState(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will set the annotation state.
- setStateModel(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
This will set the annotation state model.
- setStatus(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the status string.
- setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the stem H for the font.
- setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the stem H for the font.
- setStemH(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the stem H for the font.
- setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the stem V for the font.
- setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the stem V for the font.
- setStemV(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the stem V for the font.
- setStencilColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Set the current non stroking colorstate.
- setStream(PDTextStream) - Method in class org.apache.pdfbox.pdmodel.common.PDNamedTextStream
-
This will set the stream.
- setString(int, String) - Method in class org.apache.pdfbox.cos.COSArray
-
Set the value in the array as a string.
- setString(String, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSString
object.
- setString(COSName, String) - Method in class org.apache.pdfbox.cos.COSDictionary
-
This is a convenience method that will convert the value to a COSString
object.
- setString(String, String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject
-
Sets a string attribute value.
- setStroke(BasicStroke) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
This will set the current stroke.
- setStrokeAdjustment(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
set the value of the stroke adjustment.
- setStrokingAlphaConstant(Float) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the stroking alpha constant.
- SetStrokingCalRGBColor - Class in org.apache.pdfbox.util.operator
-
Structural modification of the PDFEngine class :
the long sequence of conditions in processOperator is replaced by
this strategy pattern.
- SetStrokingCalRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingCalRGBColor
-
- SetStrokingCMYKColor - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetStrokingCMYKColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingCMYKColor
-
- setStrokingColor(float[]) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the color components of current stroking colorspace.
- setStrokingColor(Color) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as RGB.
- setStrokingColor(int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as RGB, 0-255.
- setStrokingColor(int, int, int, int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as CMYK, 0-255.
- setStrokingColor(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as CMYK, 0.0-1.0.
- setStrokingColor(int) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as grayscale, 0-255.
- setStrokingColor(double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color, specified as Grayscale 0.0-1.0.
- SetStrokingColor - Class in org.apache.pdfbox.util.operator
-
Set the stroking color space.
- SetStrokingColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingColor
-
- setStrokingColorSpace(PDColorSpace) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Set the stroking color space.
- SetStrokingColorSpace - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetStrokingColorSpace() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingColorSpace
-
- SetStrokingDeviceN - Class in org.apache.pdfbox.util.operator
-
- SetStrokingDeviceN() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingDeviceN
-
- SetStrokingGrayColor - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetStrokingGrayColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingGrayColor
-
- SetStrokingICCBasedColor - Class in org.apache.pdfbox.util.operator
-
- SetStrokingICCBasedColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingICCBasedColor
-
- setStrokingOverprintControl(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the overprint control(OP).
- SetStrokingPattern - Class in org.apache.pdfbox.util.operator
-
Set the stroking pattern.
- SetStrokingPattern() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingPattern
-
- SetStrokingRGBColor - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetStrokingRGBColor() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingRGBColor
-
- SetStrokingSeparation - Class in org.apache.pdfbox.util.operator
-
- SetStrokingSeparation() - Constructor for class org.apache.pdfbox.util.operator.SetStrokingSeparation
-
- setStructuredElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the structure element for this node.
- setStructureElement(PDStructureElement) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject
-
Sets the structure element.
- setStructureTreeRoot(PDStructureTreeRoot) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the document's structure tree root.
- setStructureType(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the structure type (S).
- setStyle(String) - Method in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Sets the numbering style for this page range.
- setStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
This will set the border effect, see the STYLE_* constants for valid values.
- setStyle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will set the border style, see the STYLE_* constants for valid values.
- setSubFilter(String) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
Set the subfilter entry of the encryption dictionary.
- setSubFilter(COSName) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
Set a subfilter that specify the signature that should be used.
- setSubject(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
A short description of the annotation.
- setSubject(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
This will set the short description of the subject of the annotation.
- setSubject(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the subject of the document.
- setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.common.filespecification.PDEmbeddedFile
-
Set the subtype for this embedded file.
- setSubType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will set the type of action that the actions dictionary describes.
- setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
This will set the sub type (and hence appearance, AP taking precedence) For
this annotation.
- setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
This will set the sub type (and hence appearance, AP taking precedence) For
this annotation.
- setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDExternalDataDictionary
-
This will set the subtype of the external data dictionary.
- setSubtype(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDMeasureDictionary
-
This will set the subtype of the measure dictionary.
- setSummary(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDExportFormatAttributeObject
-
Sets the summary of the table???s purpose and structure.
- setSummary(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
Sets the summary of the table???s purpose and structure.
- setSuppressDuplicateOverlappingText(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
By default the text stripper will attempt to remove text that overlapps each other.
- setSuspect(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Set the value of the suspects property.
- setSymbolic(boolean) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
A convenience method that sets the flag bit.
- setTarget(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFDictionary
-
This will set the target frame in the browser to open this document.
- setTBorderStyles(String[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the style of the border drawn on each edge of a table cell
(TBorderStyle).
- setTempDirectory(File) - Method in class org.apache.pdfbox.pdfparser.PDFParser
-
This is the directory where pdfbox will create a temporary file
for storing pdf document stream in.
- setTemplateReference(FDFNamedPageReference) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
This will set the template reference.
- setTemplates(List) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFPage
-
A list of FDFTemplate objects.
- setTerminator(char) - Method in class org.apache.pdfbox.io.ASCII85OutputStream
-
This will set the terminating character.
- setTextAlign(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the alignment, in the inline-progression direction, of text and
other content within lines of the BLSE (TextAlign).
- setTextColor(PDColorState) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the text color for this node.
- setTextColor(Color) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the text color for this node.
- setTextDecorationColor(PDGamma) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the colour to be used for drawing text decorations
(TextDecorationColor).
- setTextDecorationThickness(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the thickness of each line drawn as part of the text decoration
(TextDecorationThickness).
- setTextDecorationThickness(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the thickness of each line drawn as part of the text decoration
(TextDecorationThickness).
- setTextDecorationType(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the type of text decoration (TextDecorationType).
- SetTextFont - Class in org.apache.pdfbox.util.operator
-
- SetTextFont() - Constructor for class org.apache.pdfbox.util.operator.SetTextFont
-
- setTextIndent(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the additional distance in the inline-progression direction from the
start edge of the BLSE, as specified by StartIndent, to that of the first
line of text (TextIndent).
- setTextIndent(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the additional distance in the inline-progression direction from the
start edge of the BLSE, as specified by StartIndent, to that of the first
line of text (TextIndent).
- setTextKnockoutFlag(boolean) - Method in class org.apache.pdfbox.pdmodel.graphics.PDExtendedGraphicsState
-
This will get the text knockout flag.
- SetTextLeading - Class in org.apache.pdfbox.util.operator
-
- SetTextLeading() - Constructor for class org.apache.pdfbox.util.operator.SetTextLeading
-
- setTextLineMatrix(Matrix) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- setTextMatrix(double, double, double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
The Tm operator.
- setTextMatrix(AffineTransform) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
The Tm operator.
- setTextMatrix(Matrix) - Method in class org.apache.pdfbox.util.PDFStreamEngine
-
- SetTextRenderingMode - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetTextRenderingMode() - Constructor for class org.apache.pdfbox.util.operator.SetTextRenderingMode
-
- SetTextRise - Class in org.apache.pdfbox.util.operator
-
Structal modification of the PDFEngine class :
the long sequence of conditions in processOperator is remplaced by
this strategy pattern.
- SetTextRise() - Constructor for class org.apache.pdfbox.util.operator.SetTextRise
-
- setTextRotation(double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
The Tm operator.
- setTextScaling(double, double, double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
The Tm operator.
- setTextState(PDTextState) - Method in class org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
This will set the graphics text state.
- setTextTranslation(double, double) - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
The Tm operator.
- setThousandsSeparator(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the text to be used between orders of thousands in display of numerical values.
- setThread(PDThread) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThreadBead
-
Set the thread that this bead is part of.
- setThreadBeads(List<PDThreadBead>) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the list of thread beads.
- setThreadInfo(PDDocumentInformation) - Method in class org.apache.pdfbox.pdmodel.interactive.pagenavigation.PDThread
-
Set the thread info, can be null.
- setThreads(List) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the list of threads for this pdf document.
- setTilingType(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the tiling type.
- setTintTransform(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDDeviceN
-
This will set the tint transform function.
- setTintTransform(PDFunction) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDSeparation
-
This will set the tint transform function.
- setTitle(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureElement
-
Sets the title (T).
- setTitle(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set a unique title for an annotation.
- setTitle(String) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.outline.PDOutlineItem
-
Set the title for this node.
- setTitle(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the title of the document.
- setTitlePopup(String) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Set the string used as the title of the popup window shown when open and
active (by convention this identifies who added the annotation).
- setToggleNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotation
-
Set the toggleNoView flag.
- setToggleNoView(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
-
Set the toggleNoView flag.
- setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
-
Set the top y-coordinate, a value of -1 implies that the current y-coordinate
will be used.
- setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageFitWidthDestination
-
Set the top y-coordinate, a value of -1 implies that the current y-coordinate
will be used.
- setTop(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Set the top y-coordinate, a value of -1 implies that the current y-coordinate
will be used.
- setToUnicode(COSBase) - Method in class org.apache.pdfbox.pdmodel.font.PDSimpleFont
-
This will set the ToUnicode object.
- setTPaddings(float[]) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the table paddings for four sides separately (TPadding).
- setTrackMousePosition(boolean) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will specify whether to track the mouse position when the URI is resolved.
- setTrailer(COSDictionary) - Method in class org.apache.pdfbox.cos.COSDocument
-
// MIT added, maybe this should not be supported as trailer is a persistence construct.
- setTrailer(COSDictionary) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Adds trailer information for current XRef object.
- setTrapped(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentInformation
-
This will set the trapped of the document.
- setTrimBox(PDRectangle) - Method in class org.apache.pdfbox.pdmodel.PDPage
-
This will set the TrimBox for this page.
- setType(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDAction
-
This will set the type of PDF object that the actions dictionary describes.
- setU(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the mouse button
is released inside the annotation's active area.
- setUnits(String) - Method in class org.apache.pdfbox.pdmodel.interactive.measurement.PDNumberFormatDictionary
-
This will set the label for the units.
- setUpperRightX(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will set the upper right x coordinate.
- setUpperRightY(float) - Method in class org.apache.pdfbox.pdmodel.common.PDRectangle
-
This will set the upper right y coordinate.
- setURI(String) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will set the uniform resource identifier to resolve, encoded in 7-bit ASCII.
- setURI(PDURIDictionary) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the document level uri.
- setUserKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the U entry in the standard encryption dictionary.
- setUserKey(byte[]) - Method in class org.apache.pdfbox.pdmodel.encryption.PDStandardEncryption
-
Deprecated.
This will set the U entry in the standard encryption dictionary.
- setUserPassword(String) - Method in class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Setter of the property userPassword.
- setUserProperties(boolean) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkInfo
-
Set if the structure elements contain user properties.
- setUserProperties(List<PDUserProperty>) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserAttributeObject
-
Sets the user properties.
- setV(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions
-
This will set a JavaScript action to be performed
when the field's value is changed.
- setValue(float) - Method in class org.apache.pdfbox.cos.COSFloat
-
Set the value of the float object.
- setValue(long) - Method in class org.apache.pdfbox.cos.COSInteger
-
Change the value of this reference.
- setValue(Object) - Method in class org.apache.pdfbox.pdfviewer.ArrayEntry
-
This will set the value for this entry.
- setValue(Object) - Method in class org.apache.pdfbox.pdfviewer.MapEntry
-
This will set the value for this entry.
- setValue(int, int, float) - Method in class org.apache.pdfbox.pdmodel.common.PDMatrix
-
This will set a value at a position.
- setValue(COSBase) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDUserProperty
-
Sets the property value.
- setValue(Object) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
You should pass in a string, or a java.util.List of strings to set the
value.
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDCheckbox
-
setValue sets the fields value to a given string.
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDChoiceField
-
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDField
-
setValue sets the fields value to a given string.
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDPushButton
-
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDRadioCollection
-
This setValue method iterates the collection of radiobuttons
and checks or unchecks each radiobutton according to the
given value.
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignature
-
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField
-
Deprecated.
use setSignature(PDSignature) instead
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDUnknownField
-
setValue sets the fields value to a given string.
- setValue(String) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
- setValue(int, int, float) - Method in class org.apache.pdfbox.util.Matrix
-
This will set a value at a position.
- setVersion(float) - Method in class org.apache.pdfbox.cos.COSDocument
-
This will set the version of this PDF document.
- setVersion(int) - Method in class org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary
-
This will set the V entry of the encryption dictionary.
- setVersion(String) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFCatalog
-
This will set the version of the FDF document.
- setVersion(String) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Sets the PDF specification version this document conforms to.
- setVerticesPerRow(int) - Method in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingType5
-
Set the number of vertices per row.
- setViewArea(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setViewArea(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the ViewArea preference.
- setViewClip(PDViewerPreferences.BOUNDARY) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Set the ViewClip preference.
- setViewClip(String) - Method in class org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences
-
Deprecated.
- setViewerPreferences(PDViewerPreferences) - Method in class org.apache.pdfbox.pdmodel.PDDocumentCatalog
-
Set the viewer preferences.
- setVisualSignature(InputStream) - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
Reads the visual signature from the given input stream.
- 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.
- setWarnMissingClose(boolean) - Method in class org.apache.pdfbox.cos.COSDocument
-
Controls whether this instance shall issue a warning if the PDF document wasn't closed
properly through a call to the
COSDocument.close() method.
- setWC(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will set a JavaScript action to be performed
before closing a document.
- setWhitepoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalGray
-
This will set the whitepoint tristimulus.
- setWhitepoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDCalRGB
-
This will set the whitepoint tristimulus.
- setWhitepoint(PDTristimulus) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDLab
-
This will set the whitepoint tristimulus.
- setWidgetFieldFlags(Integer) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the widget field flags that are associated with this field.
- setWidgetFieldFlags(int) - Method in class org.apache.pdfbox.pdmodel.fdf.FDFField
-
This will get the field flags that are associated with this field.
- setWidth(float) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the width of the element???s content rectangle in the
inline-progression direction (Width).
- setWidth(int) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the width of the element???s content rectangle in the
inline-progression direction (Width).
- setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.Optimum
- setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.predictor.PredictorAlgorithm
-
- setWidth(int) - Method in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
Set the width of the image.
- setWidth(float) - Method in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
This will set the border width in points, 0 = no border.
- setWidth(int) - Method in class org.apache.pdfbox.util.ImageParameters
-
Set the width of the image.
- setWidthAuto() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
- setWidths(List<Float>) - Method in class org.apache.pdfbox.pdmodel.font.PDFont
-
Set the widths of the characters code.
- setWinLaunchParams(PDWindowsLaunchParams) - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will set a dictionary containing Windows-specific launch parameters.
- setWordSeparator(String) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Set the desired word separator for output text.
- setWordSpacing(float) - Method in class org.apache.pdfbox.pdmodel.text.PDTextState
-
Set the value of the wordSpacing.
- SetWordSpacing - Class in org.apache.pdfbox.util.operator
-
- SetWordSpacing() - Constructor for class org.apache.pdfbox.util.operator.SetWordSpacing
-
- setWP(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will set a JavaScript action to be performed
before printing a document.
- setWritingMode(String) - Method in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject
-
Sets the writing mode (WritingMode).
- setWS(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDDocumentCatalogAdditionalActions
-
This will set a JavaScript action to be performed
before saving a document.
- setX(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will set the x value of the tristimulus.
- setX(PDAction) - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDAnnotationAdditionalActions
-
This will set an action to be performed when the cursor
exits the annotation's active area.
- setX509(X509Certificate) - Method in class org.apache.pdfbox.pdmodel.encryption.PublicKeyRecipient
-
Set the X509 certificate of the recipient.
- setXFA(PDXFA) - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm
-
Set the XFA resource, this is only used for PDF 1.5+ forms.
- setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptor
-
This will set the x height for the font.
- setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorAFM
-
This will set the x height for the font.
- setXHeight(float) - Method in class org.apache.pdfbox.pdmodel.font.PDFontDescriptorDictionary
-
This will set the x height for the font.
- setXObjects(Map<String, PDXObject>) - Method in class org.apache.pdfbox.pdmodel.PDResources
-
This will set the map of xobjects.
- setXRef(COSObjectKey, long) - Method in class org.apache.pdfbox.pdfparser.XrefTrailerResolver
-
Populate XRef HashMap of current XRef object.
- setXStep(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the XStep value.
- setY(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will set the y value of the tristimulus.
- setYStep(int) - Method in class org.apache.pdfbox.pdmodel.graphics.pattern.PDTilingPatternResources
-
This will set the YStep value.
- setZ(float) - Method in class org.apache.pdfbox.pdmodel.graphics.color.PDTristimulus
-
This will set the z value of the tristimulus.
- setZoom(int) - Method in class org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageXYZDestination
-
Set the zoom value for the page, a value of -1 implies that the current zoom
will be used.
- SHADING - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SHADING_PATTERN - Static variable in class org.apache.pdfbox.pdmodel.graphics.pattern.PDPatternResources
-
- SHADING_TYPE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SHADING_TYPE1 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 1 = function based shading.
- SHADING_TYPE2 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 2 = axial shading.
- SHADING_TYPE3 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 3 = radial shading.
- SHADING_TYPE4 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 4 = Free-Form Gouraud-Shaded Triangle Meshes.
- SHADING_TYPE5 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 5 = Lattice-Form Gouraud-Shaded Triangle Meshes.
- SHADING_TYPE6 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 6 = Coons Patch Meshes.
- SHADING_TYPE7 - Static variable in class org.apache.pdfbox.pdmodel.graphics.shading.PDShadingResources
-
shading type 7 = Tensor-Product Patch Meshes.
- SHFill(COSName) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Deprecated.
use {@link #shFill(COSName)) instead.
- shFill(COSName) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with Shading.
- SHFill - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of sh operator for page drawer.
- SHFill() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.SHFill
-
- SHFill_Axial(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with an Axial Shading.
- SHFill_CoonsPatch(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Coons patch mesh
If extending the class, override this and its siblings, not the public SHFill method.
- SHFill_FreeGourad(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Free-form Gourad-shaded triangle mesh.
- SHFill_Function(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Function-based gradient / shading.
- SHFill_LatticeGourad(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Lattice-form Gourad-shaded triangle mesh.
- SHFill_Radial(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Radial gradient / shading.
- SHFill_TensorPatch(PDShading) - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Fill with a Tensor-product patch mesh.
- shouldComb() - Method in class org.apache.pdfbox.pdmodel.interactive.form.PDVariableText
-
- shouldOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This will specify whether to open the destination document in a new window.
- shouldOpenInNewWindow() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This will specify whether to open the destination document in a new window.
- shouldRename() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFTemplate
-
A flag telling if the fields imported from the template may be renamed if there are conflicts.
- shouldScaleToFitAnnotation() - Method in class org.apache.pdfbox.pdmodel.fdf.FDFIconFit
-
This will tell if the icon should scale to fit the annotation bounds.
- shouldTrackMousePosition() - Method in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This will specify whether to track the mouse position when the URI is resolved.
- ShowText - Class in org.apache.pdfbox.util.operator
-
- ShowText() - Constructor for class org.apache.pdfbox.util.operator.ShowText
-
- ShowTextGlyph - Class in org.apache.pdfbox.util.operator
-
- ShowTextGlyph() - Constructor for class org.apache.pdfbox.util.operator.ShowTextGlyph
-
- SIG - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SIG_FLAGS - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- sign(InputStream) - Method in interface org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface
-
Creates a cms signature for the given content
- SignatureException - Exception in org.apache.pdfbox.exceptions
-
An exception that indicates a problem during the signing process.
- SignatureException(String) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
-
Constructor.
- SignatureException(int, String) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
-
Constructor.
- SignatureException(Throwable) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
-
Constructor.
- SignatureException(int, Throwable) - Constructor for exception org.apache.pdfbox.exceptions.SignatureException
-
Constructor.
- 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
-
- SignatureOptions() - Constructor for class org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions
-
- silentPrint() - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will send the PDF to the default printer without prompting the user
for any printer settings.
- silentPrint(PrinterJob) - Method in class org.apache.pdfbox.pdmodel.PDDocument
-
This will send the PDF to the default printer without prompting the user
for any printer settings.
- size() - Method in class org.apache.pdfbox.cos.COSArray
-
This will get the size of this array.
- size() - Method in class org.apache.pdfbox.cos.COSDictionary
-
This will return the number of elements in this dictionary.
- SIZE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- size() - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
-
Totally available bytes in the underlying array.
- size() - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
- size() - Method in class org.apache.pdfbox.pdmodel.common.COSDictionaryMap
- size() - Method in class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.Revisions
-
Returns the size.
- skip(long) - Method in class org.apache.pdfbox.io.ASCII85InputStream
-
Unsupported.
- skip(long) - Method in class org.apache.pdfbox.io.ByteArrayPushBackInputStream
-
Skips over and discards n bytes of data from this input stream.
- skip(long) - Method in class org.apache.pdfbox.io.RandomAccessBufferedFileInputStream
-
- skip(long) - Method in class org.apache.pdfbox.io.RandomAccessFileInputStream
- skipSpaces() - Method in class org.apache.pdfbox.pdfparser.BaseParser
-
This will skip all spaces and comments that are present.
- SM - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SMASK - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- sourceDocument - Variable in class org.apache.pdfbox.util.PageExtractor
-
- SPACE - Static variable in class org.apache.pdfbox.pdfwriter.ContentStreamWriter
-
space character.
- SPACE - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
-
space character.
- SPAN - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.StandardStructureTypes
-
Span
- split(PDDocument) - Method in class org.apache.pdfbox.util.Splitter
-
This will take a document and split into several other documents.
- Splitter - Class in org.apache.pdfbox.util
-
Split a document into several other documents.
- Splitter() - Constructor for class org.apache.pdfbox.util.Splitter
-
- STANDARD_ENCODING - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- StandardDecryptionMaterial - Class in org.apache.pdfbox.pdmodel.encryption
-
Represents the necessary information to decrypt a document protected by
the standard security handler (password protection).
- StandardDecryptionMaterial(String) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardDecryptionMaterial
-
Create a new standard decryption material with the given password.
- StandardEncoding - Class in org.apache.pdfbox.encoding
-
This is an interface to a text encoder.
- StandardEncoding() - Constructor for class org.apache.pdfbox.encoding.StandardEncoding
-
Constructor.
- StandardProtectionPolicy - Class in org.apache.pdfbox.pdmodel.encryption
-
This class represents the protection policy to add to a document
for password-based protection.
- StandardProtectionPolicy(String, String, AccessPermission) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardProtectionPolicy
-
Creates an new instance of the standard protection policy
in order to protect a PDF document with passwords.
- StandardSecurityHandler - Class in org.apache.pdfbox.pdmodel.encryption
-
The class implements the standard security handler as decribed
in the PDF specifications.
- StandardSecurityHandler() - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Constructor.
- StandardSecurityHandler(StandardProtectionPolicy) - Constructor for class org.apache.pdfbox.pdmodel.encryption.StandardSecurityHandler
-
Constructor used for encryption.
- StandardStructureTypes - Class in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
-
The standard structure types.
- startArticle(boolean) - Method in class org.apache.pdfbox.util.PDFText2HTML
-
Write out the article separator (div tag) with proper text direction
information.
- startArticle() - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Start a new article, which is typically defined as a column
on a single page (also referred to as a bead).
- startArticle(boolean) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Start a new article, which is typically defined as a column
on a single page (also referred to as a bead).
- startDocument(PDDocument) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
This method is available for subclasses of this class.
- startExtraction(String[]) - Method in class org.apache.pdfbox.ExtractText
-
Starts the text extraction.
- startPage - Variable in class org.apache.pdfbox.util.PageExtractor
-
- startPage(PDPage) - Method in class org.apache.pdfbox.util.PDFTextStripper
-
Start a new page.
- STARTXREF - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
-
The start xref token.
- STATUS - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STD_CF - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STEM_H - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STEM_V - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STM_F - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STR_F - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STREAM - Static variable in class org.apache.pdfbox.pdfwriter.COSWriter
-
The open stream token.
- STRING_CLOSE - Static variable in class org.apache.pdfbox.cos.COSString
-
One of the close string tokens.
- STRING_OPEN - Static variable in class org.apache.pdfbox.cos.COSString
-
One of the open string tokens.
- StringUtil - Class in org.apache.pdfbox.util
-
- StringUtil() - Constructor for class org.apache.pdfbox.util.StringUtil
-
- stroke() - Method in class org.apache.pdfbox.pdmodel.edit.PDPageContentStream
-
Stroke the path.
- strokePath() - Method in class org.apache.pdfbox.pdfviewer.PageDrawer
-
Stroke the path.
- StrokePath - Class in org.apache.pdfbox.util.operator.pagedrawer
-
Implementation of content stream operator for page drawer.
- StrokePath() - Constructor for class org.apache.pdfbox.util.operator.pagedrawer.StrokePath
-
- STRUCT_TREE_ROOT - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- STYLE_BEVELED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constant for the name of a beveled style.
- STYLE_CLOUDY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
Constant for the name of a cloudy effect.
- STYLE_DASHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constant for the name of a dashed style.
- STYLE_DECIMAL - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Decimal page numbering style (1, 2, 3, ...).
- STYLE_INSET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constant for the name of a inset style.
- STYLE_LETTERS_LOWER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Letter (lower case) numbering style (a, b, ..., z, aa, bb, ..., zz, aaa,
...).
- STYLE_LETTERS_UPPER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Letter (upper case) numbering style (A, B, ..., Z, AA, BB, ..., ZZ, AAA,
...).
- STYLE_ROMAN_LOWER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Roman numbers (lower case) numbering style (i, ii, iii, iv, ...).
- STYLE_ROMAN_UPPER - Static variable in class org.apache.pdfbox.pdmodel.common.PDPageLabelRange
-
Roman numbers (upper case) numbering style (I, II, III, IV, ...).
- STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
-
Constant for the name for no effect.
- STYLE_SOLID - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constant for the name of a solid style.
- STYLE_UNDERLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderStyleDictionary
-
Constant for the name of a underline style.
- Sub - Class in org.apache.pdfbox.pdmodel.graphics.predictor
-
The sub algorithm.
- Sub() - Constructor for class org.apache.pdfbox.pdmodel.graphics.predictor.Sub
-
- SUB_FILTER - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectForm
-
The XObject subtype.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.graphics.xobject.PDXObjectImage
-
The XObject subtype.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionGoTo
-
This type of action this object represents.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionJavaScript
-
This type of action this object represents.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionLaunch
-
This type of action this object represents.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionRemoteGoTo
-
This type of action this object represents.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.action.type.PDActionURI
-
This type of action this object represents.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationText
-
The type of annotation.
- SUB_TYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget
-
The type of annotation.
- SUB_TYPE_CARET - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for an Caret type of annotation.
- SUB_TYPE_CIRCLE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
Constant for an Eliptical type of annotation.
- SUB_TYPE_FREETEXT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for a FreeText type of annotation.
- SUB_TYPE_HIGHLIGHT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
The types of annotation.
- SUB_TYPE_INK - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for an Ink type of annotation.
- SUB_TYPE_POLYGON - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for an Polygon type of annotation.
- SUB_TYPE_POLYLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for an PolyLine type of annotation.
- SUB_TYPE_SOUND - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup
-
Constant for an Sound type of annotation.
- SUB_TYPE_SQUARE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle
-
Constant for a Rectangular type of annotation.
- SUB_TYPE_SQUIGGLY - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
The types of annotation.
- SUB_TYPE_STRIKEOUT - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
The types of annotation.
- SUB_TYPE_UNDERLINE - Static variable in class org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup
-
The types of annotation.
- SUBFILTER - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SUBFILTER_ADBE_PKCS7_DETACHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
A signature subfilter value.
- SUBFILTER_ADBE_PKCS7_SHA1 - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
A signature subfilter value.
- SUBFILTER_ADBE_X509_RSA_SHA1 - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
A signature subfilter value.
- SUBFILTER_ETSI_CADES_DETACHED - Static variable in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature
-
A signature subfilter value.
- SUBJ - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SUBJECT - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- subList(int, int) - Method in class org.apache.pdfbox.pdmodel.common.COSArrayList
- substituteCMap(String) - Static method in class org.apache.pdfbox.encoding.conversion.CMapSubstitution
-
- SUBTYPE - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCaret
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationCircle
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFileAttachment
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationFreeText
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationHighlight
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationInk
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationLine
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolygon
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationPolyline
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSound
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquare
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationSquiggly
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStamp
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationStrikeOut
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationText
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.fdf.FDFAnnotationUnderline
-
COS Model value for SubType entry.
- SUBTYPE - Static variable in class org.apache.pdfbox.pdmodel.interactive.measurement.PDRectlinearMeasureDictionary
-
The subtype of the rectlinear measure dictionary.
- SUMMARY - Static variable in class org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDTableAttributeObject
-
- SUPPLEMENT - Static variable in class org.apache.pdfbox.cos.COSName
-
A common COSName value.
- SYMBOL - Static variable in class org.apache.pdfbox.pdmodel.font.PDType1Font
-
Standard Base 14 Font.
- SYSPROP_EOFLOOKUPRANGE - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
- SYSPROP_PARSEMINIMAL - Static variable in class org.apache.pdfbox.pdfparser.NonSequentialPDFParser
-
- systemLineSeparator - Variable in class org.apache.pdfbox.util.PDFTextStripper
-
The platforms line separator.