Package | Description |
---|---|
org.apache.pdfbox.contentstream |
This package contains provides classes for working with content streams.
|
org.apache.pdfbox.cos |
These are the low level objects that make up a PDF document.
|
org.apache.pdfbox.debugger.colorpane | |
org.apache.pdfbox.multipdf | |
org.apache.pdfbox.pdfparser |
The pdfparser package contains classes to parse PDF documents and objects within the document.
|
org.apache.pdfbox.pdfwriter |
This is the persistence layer used to write the PDFBox documents to a stream.
|
org.apache.pdfbox.pdmodel |
The PDModel package represents a high level API for creating and manipulating PDF documents.
|
org.apache.pdfbox.pdmodel.common |
High level PD classes that are used throughout several packages are placed in the PDModel common package.
|
org.apache.pdfbox.pdmodel.common.function |
This package contains functions that are available in the PDF specification.
|
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure |
The logical structure package provides a mechanism for incorporating
structural information about a document's content into a PDF file.
|
org.apache.pdfbox.pdmodel.documentinterchange.prepress |
This package contains classes for prepress support in PDFBox.
|
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf |
The tagged PDF package provides a mechanism for incorporating "tags" (standard
structure types and attributes) into a PDF file.
|
org.apache.pdfbox.pdmodel.encryption |
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
|
org.apache.pdfbox.pdmodel.fdf |
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
|
org.apache.pdfbox.pdmodel.font |
Classes to deal with font functionality in a PDF Document.
|
org.apache.pdfbox.pdmodel.font.encoding | |
org.apache.pdfbox.pdmodel.graphics |
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
|
org.apache.pdfbox.pdmodel.graphics.color |
This package deals with colors that are stored in a PDF document.
|
org.apache.pdfbox.pdmodel.graphics.image |
This package deals with images that are stored in a PDF document.
|
org.apache.pdfbox.pdmodel.graphics.optionalcontent | |
org.apache.pdfbox.pdmodel.graphics.shading |
This package deals with shadings which are used for filling instead of a color.
|
org.apache.pdfbox.pdmodel.graphics.state |
This package deals with graphics states within the PDF document.
|
org.apache.pdfbox.pdmodel.interactive.action |
This package represents actions that can be performed in a PDF document.
|
org.apache.pdfbox.pdmodel.interactive.annotation |
The annotation package contains classes that work with PDF annotation elements.
|
org.apache.pdfbox.pdmodel.interactive.digitalsignature |
The digital signature library will manage signatures that are stored in the PDF document.
|
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible |
This is the visual signature part that help creating the visual representation for the digital signature.
|
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination |
The destination package allows destinations into a pdf document to be specified.
|
org.apache.pdfbox.preflight.action | |
org.apache.pdfbox.preflight.parser | |
org.apache.pdfbox.preflight.process.reflect | |
org.apache.pdfbox.preflight.utils | |
org.apache.pdfbox.util |
This package contains utility classes that are used by the PDFBox project.
|
Modifier and Type | Method and Description |
---|---|
void |
PDFStreamEngine.setLineDashPattern(COSArray array,
int phase) |
void |
PDFStreamEngine.showTextStrings(COSArray array)
Called when a string of text with spacing adjustments is to be shown.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
COSDictionary.getCOSArray(COSName key)
This is a convenience method that will get the dictionary object that is expected to be a COSArray.
|
COSArray |
COSDocument.getDocumentID()
This will get the document ID.
|
Modifier and Type | Method and Description |
---|---|
void |
COSArray.addAll(COSArray objectList)
This will add all objects to this array.
|
void |
COSDocument.setDocumentID(COSArray id)
This will set the document ID.
|
java.lang.Object |
ICOSVisitor.visitFromArray(COSArray obj)
Notification of visit to Array object.
|
Modifier and Type | Method and Description |
---|---|
private int |
CSIndexed.getHival(COSArray array) |
Constructor and Description |
---|
CSArrayBased(COSArray array) |
CSDeviceN(COSArray array)
Constructor
|
CSIndexed(COSArray array)
Constructor.
|
CSSeparation(COSArray array)
Constructor
|
Modifier and Type | Method and Description |
---|---|
private void |
Overlay.addOriginalContent(COSBase contents,
COSArray contentArray) |
private void |
Overlay.overlayPage(PDPage page,
Overlay.LayoutPage layoutPage,
COSArray array) |
private void |
PDFMergerUtility.updatePageReferences(PDFCloneUtility cloner,
COSArray parentTreeEntry,
java.util.Map<COSDictionary,COSDictionary> objMapping) |
private void |
PDFMergerUtility.updateParentEntry(COSArray kArray,
COSDictionary newParent)
Update the P reference to the new parent dictionary.
|
Modifier and Type | Method and Description |
---|---|
protected COSArray |
BaseParser.parseCOSArray()
This will parse a PDF array object.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
COSWriter.byteRangeArray |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
COSWriter.visitFromArray(COSArray obj) |
Modifier and Type | Method and Description |
---|---|
void |
PDAppearanceContentStream.setBorderLine(float lineWidth,
PDBorderStyleDictionary bs,
COSArray border)
Convenience method for annotations: sets the line with and dash style.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
COSArrayList.array |
private COSArray |
PDRange.rangeArray |
private COSArray |
PDRectangle.rectArray |
Modifier and Type | Method and Description |
---|---|
static COSArray |
COSArrayList.converterToCOSArray(java.util.List<?> cosObjectableList)
This will convert a list of COSObjectables to an array list of COSBase objects.
|
static COSArray |
COSArrayList.convertStringListToCOSNameCOSArray(java.util.List<java.lang.String> strings)
This will take an list of string objects and return a COSArray of COSName
objects.
|
static COSArray |
COSArrayList.convertStringListToCOSStringCOSArray(java.util.List<java.lang.String> strings)
This will take an list of string objects and return a COSArray of COSName
objects.
|
COSArray |
COSArrayList.getCOSArray()
This will return the underlying COSArray.
|
COSArray |
PDRectangle.getCOSArray()
This will get the underlying array for this rectangle.
|
COSArray |
PDRange.getCOSArray()
This will get the underlying array value.
|
COSArray |
COSArrayList.toList()
Deprecated.
use
COSArrayList.getCOSArray() instead. |
Modifier and Type | Method and Description |
---|---|
static java.util.List<java.lang.String> |
COSArrayList.convertCOSNameCOSArrayToList(COSArray nameArray)
This will take an array of COSName and return a COSArrayList of
java.lang.String values.
|
static java.util.List<java.lang.String> |
COSArrayList.convertCOSStringCOSArrayToList(COSArray stringArray)
This will take an array of COSString and return a COSArrayList of
java.lang.String values.
|
static java.util.List<java.lang.Float> |
COSArrayList.convertFloatCOSArrayToList(COSArray floatArray)
This will take an array of COSNumbers and return a COSArrayList of
java.lang.Float values.
|
static java.util.List<java.lang.Integer> |
COSArrayList.convertIntegerCOSArrayToList(COSArray intArray)
This will take an array of COSNumbers and return a COSArrayList of
java.lang.Integer values.
|
Constructor and Description |
---|
COSArrayList(java.util.List<E> actualList,
COSArray cosArray)
Constructor.
|
PDRange(COSArray range)
Constructor assumes a starting index of 0.
|
PDRange(COSArray range,
int index)
Constructor with an index into an array.
|
PDRectangle(COSArray array)
Constructor.
|
PDStream(PDDocument doc,
java.io.InputStream input,
COSArray filters)
Constructor.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDFunctionType3.bounds |
private COSArray |
PDFunctionType2.c0
The C0 values of the exponential function.
|
private COSArray |
PDFunctionType2.c1
The C1 values of the exponential function.
|
private COSArray |
PDFunctionType0.decode
An array of 2 x n numbers specifying the linear mapping of sample values
into the range appropriate for the function's output values.
|
private COSArray |
PDFunction.domain |
private COSArray |
PDFunctionType3.encode |
private COSArray |
PDFunctionType0.encode
An array of 2 x m numbers specifying the linear mapping of input values
into the domain of the function's sample table.
|
private COSArray |
PDFunctionType3.functions |
private COSArray |
PDFunction.range |
private COSArray |
PDFunctionType0.size
An array of m positive integers specifying the number of samples in each
input dimension of the sample table.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDFunction.eval(COSArray input)
Deprecated.
Replaced by
PDFunction.eval(float[] input) |
COSArray |
PDFunctionType3.getBounds()
Returns all bounds values as COSArray.
|
COSArray |
PDFunctionType2.getC0()
Returns the C0 values of the function, 0 if empty.
|
COSArray |
PDFunctionType2.getC1()
Returns the C1 values of the function, 1 if empty.
|
private COSArray |
PDFunctionType0.getDecodeValues()
Returns all decode values as COSArray.
|
private COSArray |
PDFunction.getDomainValues()
Returns all domains for the input values as COSArray.
|
COSArray |
PDFunctionType3.getEncode()
Returns all encode values as COSArray.
|
private COSArray |
PDFunctionType0.getEncodeValues()
Returns all encode values as COSArray.
|
COSArray |
PDFunctionType3.getFunctions()
Returns all functions values as COSArray.
|
protected COSArray |
PDFunction.getRangeValues()
Returns all ranges for the output values as COSArray .
|
COSArray |
PDFunctionType0.getSize()
The "Size" entry, which is the number of samples in each input dimension
of the sample table.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDFunction.eval(COSArray input)
Deprecated.
Replaced by
PDFunction.eval(float[] input) |
void |
PDFunctionType0.setDecodeValues(COSArray decodeValues)
This will set the decode values.
|
void |
PDFunction.setDomainValues(COSArray domainValues)
This will set the domain values.
|
void |
PDFunctionType0.setEncodeValues(COSArray encodeValues)
This will set the encode values.
|
void |
PDFunction.setRangeValues(COSArray rangeValues)
This will set the range values.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDStructureTreeRoot.getKArray()
Deprecated.
use
PDStructureTreeRoot.getK() only. /K can be a dictionary or an array, and the next level
can also be a dictionary. See file 054080.pdf in PDFBOX-4417 and read "Entries in the
structure tree root" in the PDF specification. |
Constructor and Description |
---|
PDParentTreeValue(COSArray obj) |
Modifier and Type | Method and Description |
---|---|
void |
PDBoxStyle.setLineDashPattern(COSArray dashArray)
Set the line dash pattern associated with this box style.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDFourColours.array |
Constructor and Description |
---|
PDFourColours(COSArray array) |
Modifier and Type | Method and Description |
---|---|
private void |
SecurityHandler.decryptArray(COSArray array,
long objNum,
long genNum)
This will decrypt an array.
|
private byte[] |
StandardSecurityHandler.getDocumentIDBytes(COSArray documentIDArray) |
abstract void |
SecurityHandler.prepareForDecryption(PDEncryption encryption,
COSArray documentIDArray,
DecryptionMaterial decryptionMaterial)
Prepares everything to decrypt the document.
|
void |
StandardSecurityHandler.prepareForDecryption(PDEncryption encryption,
COSArray documentIDArray,
DecryptionMaterial decryptionMaterial)
Prepares everything to decrypt the document.
|
void |
PublicKeySecurityHandler.prepareForDecryption(PDEncryption encryption,
COSArray documentIDArray,
DecryptionMaterial decryptionMaterial)
Prepares everything to decrypt the document.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
FDFOptionElement.option |
Modifier and Type | Method and Description |
---|---|
COSArray |
FDFOptionElement.getCOSArray()
Convert this standard java object to a COS object.
|
COSArray |
FDFDictionary.getID()
This is the FDF id.
|
private COSArray |
FDFAnnotationStamp.parseArrayElement(org.w3c.dom.Element arrayEl) |
Modifier and Type | Method and Description |
---|---|
void |
FDFDictionary.setID(COSArray id)
This will set the FDF id.
|
Constructor and Description |
---|
FDFOptionElement(COSArray o)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
private COSArray |
PDCIDFontType2Embedder.getVerticalMetrics(int[] values) |
private COSArray |
PDCIDFontType2Embedder.getWidths(int[] widths) |
Constructor and Description |
---|
DictionaryEncoding(COSName baseEncoding,
COSArray differences)
Creates a new DictionaryEncoding for embedding.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDFontSetting.fontSetting |
Constructor and Description |
---|
PDFontSetting(COSArray fs)
Constructs a font setting from an existing array.
|
PDLineDashPattern(COSArray array,
int phase)
Creates a new line dash pattern from a dash array and phase.
|
Modifier and Type | Field and Description |
---|---|
protected COSArray |
PDColorSpace.array |
private COSArray |
PDTristimulus.values |
private COSArray |
PDGamma.values |
Modifier and Type | Method and Description |
---|---|
COSArray |
PDGamma.getCOSArray()
Convert this standard java object to a COS object.
|
private COSArray |
PDLab.getDefaultRangeArray()
creates a range array with default values (-100..100 -100..100).
|
COSArray |
PDColor.toCOSArray()
Returns the color component values as a COS array
|
Modifier and Type | Method and Description |
---|---|
private static void |
PDICCBased.checkArray(COSArray iccArray) |
static PDICCBased |
PDICCBased.create(COSArray iccArray,
PDResources resources)
Creates a new ICC color space using the PDF array, optionally using a resource cache.
|
Constructor and Description |
---|
PDCalGray(COSArray array)
Creates a new CalGray color space using the given COS array.
|
PDCalRGB(COSArray rgb)
Creates a new CalRGB color space using the given COS array.
|
PDCIEDictionaryBasedColorSpace(COSArray rgb)
Creates a new CalRGB color space using the given COS array.
|
PDColor(COSArray array,
PDColorSpace colorSpace)
Creates a PDColor containing the given color value.
|
PDDeviceN(COSArray deviceN)
Creates a new DeviceN color space from the given COS array.
|
PDGamma(COSArray array)
Creates a new gamma from a COS array.
|
PDICCBased(COSArray iccArray)
Deprecated.
This will be private in 3.0. Please use
PDICCBased.create(org.apache.pdfbox.cos.COSArray, org.apache.pdfbox.pdmodel.PDResources)
instead, which supports caching. |
PDIndexed(COSArray indexedArray)
Creates a new indexed color space from the given PDF array.
|
PDIndexed(COSArray indexedArray,
PDResources resources)
Creates a new indexed color space from the given PDF array.
|
PDLab(COSArray lab)
Creates a new Lab color space from a PDF array.
|
PDSeparation(COSArray separation)
Creates a new Separation color space from a PDF color space array.
|
PDTristimulus(COSArray array)
Constructor from COS object.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDInlineImage.getColorKeyMask()
Deprecated.
inline images don't have a color key mask.
|
COSArray |
PDImageXObject.getColorKeyMask()
Returns the color key mask array associated with this image, or null if there is none.
|
COSArray |
PDInlineImage.getDecode() |
COSArray |
PDImage.getDecode()
Returns the decode array.
|
COSArray |
PDImageXObject.getDecode() |
Modifier and Type | Method and Description |
---|---|
private static java.awt.image.BufferedImage |
SampledImageReader.fromAny(PDImage pdImage,
java.awt.image.WritableRaster raster,
COSArray colorKey,
java.awt.Rectangle clipped,
int subsampling,
int width,
int height) |
static java.awt.image.BufferedImage |
SampledImageReader.getRGBImage(PDImage pdImage,
COSArray colorKey)
Returns the content of the given image as an AWT buffered image with an RGB color space.
|
static java.awt.image.BufferedImage |
SampledImageReader.getRGBImage(PDImage pdImage,
java.awt.Rectangle region,
int subsampling,
COSArray colorKey)
Returns the content of the given image as an AWT buffered image with an RGB color space.
|
void |
PDInlineImage.setDecode(COSArray decode) |
void |
PDImage.setDecode(COSArray decode)
Sets the decode array.
|
void |
PDImageXObject.setDecode(COSArray decode) |
Modifier and Type | Method and Description |
---|---|
private COSArray |
PDOptionalContentProperties.getOCGs() |
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDShading.background |
private COSArray |
PDShadingType2.coords |
private COSArray |
PDTriangleBasedShadingType.decode |
private COSArray |
PDShadingType2.domain |
private COSArray |
PDShadingType1.domain |
private COSArray |
PDShadingType2.extend |
Modifier and Type | Method and Description |
---|---|
COSArray |
PDShading.getBackground()
This will return the background.
|
COSArray |
PDShadingType2.getCoords()
This will get the Coords values for this shading.
|
private COSArray |
PDTriangleBasedShadingType.getDecodeValues()
Returns all decode values as COSArray.
|
COSArray |
PDShadingType2.getDomain()
This will get the optional Domain values for this shading.
|
COSArray |
PDShadingType1.getDomain()
This will get the optional Domain values of a function based shading.
|
COSArray |
PDShadingType2.getExtend()
This will get the optional Extend values for this shading.
|
Modifier and Type | Method and Description |
---|---|
void |
PDShading.setBackground(COSArray newBackground)
This will set the background.
|
void |
PDShadingType2.setCoords(COSArray newCoords)
Sets the Coords entry for this shading.
|
void |
PDTriangleBasedShadingType.setDecodeValues(COSArray decodeValues)
This will set the decode values.
|
void |
PDShadingType2.setDomain(COSArray newDomain)
Sets the optional Domain entry for this shading.
|
void |
PDShadingType1.setDomain(COSArray newDomain)
Sets the optional Domain entry for the function based shading.
|
void |
PDShadingType2.setExtend(COSArray newExtend)
Sets the optional Extend entry for this shading.
|
void |
PDShading.setFunction(COSArray newFunctions)
This will set the functions COSArray for the color conversion.
|
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDSoftMask.backdropColor |
Modifier and Type | Method and Description |
---|---|
COSArray |
PDSoftMask.getBackdropColor()
Returns the backdrop color.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDActionResetForm.getFields()
An array identifying which fields to include in the submission or which to exclude, depending
on the setting of the Include/Exclude flag in the Flags entry
|
COSArray |
PDActionSubmitForm.getFields()
An array identifying which fields to include in the submission or which to exclude, depending
on the setting of the Include/Exclude flag in the Flags entry
|
Modifier and Type | Method and Description |
---|---|
void |
PDActionResetForm.setFields(COSArray array) |
void |
PDActionSubmitForm.setFields(COSArray array) |
Modifier and Type | Method and Description |
---|---|
COSArray |
PDAnnotation.getBorder()
This will retrieve the border array.
|
Modifier and Type | Method and Description |
---|---|
void |
PDAnnotation.setBorder(COSArray borderArray)
This will set the border array.
|
void |
PDBorderStyleDictionary.setDashStyle(COSArray dashArray)
This will set the dash style used for drawing the border.
|
Modifier and Type | Method and Description |
---|---|
private static java.util.List<byte[]> |
PDSeedValueCertificate.getListOfByteArraysFromCOSArray(COSArray array) |
Modifier and Type | Field and Description |
---|---|
private COSArray |
PDFTemplateStructure.procSet |
Modifier and Type | Method and Description |
---|---|
COSArray |
PDFTemplateStructure.getProcSet()
Gets ProcSet Array
|
Modifier and Type | Method and Description |
---|---|
void |
PDFTemplateBuilder.injectProcSetArray(PDFormXObject innerForm,
PDPage page,
PDResources innerFormResources,
PDResources imageFormResources,
PDResources holderFormResources,
COSArray procSet)
Inject procSetArray
|
void |
PDVisibleSigBuilder.injectProcSetArray(PDFormXObject innerForm,
PDPage page,
PDResources innerFormResources,
PDResources imageFormResources,
PDResources holderFormResources,
COSArray procSet) |
void |
PDFTemplateStructure.setProcSet(COSArray procSet)
Sets ProcSet Array
|
Modifier and Type | Field and Description |
---|---|
protected COSArray |
PDPageDestination.array
Storage for the page destination.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
PDPageDestination.getCOSObject()
Convert this standard java object to a COS object.
|
Constructor and Description |
---|
PDPageDestination(COSArray arr)
Constructor to create empty page destination.
|
PDPageFitDestination(COSArray arr)
Constructor from an existing destination array.
|
PDPageFitHeightDestination(COSArray arr)
Constructor from an existing destination array.
|
PDPageFitRectangleDestination(COSArray arr)
Constructor from an existing destination array.
|
PDPageFitWidthDestination(COSArray arr)
Constructor from an existing destination array.
|
PDPageXYZDestination(COSArray arr)
Constructor from an existing destination array.
|
Modifier and Type | Method and Description |
---|---|
private boolean |
GoToRemoteAction.validateExplicitDestination(COSArray ar) |
Modifier and Type | Method and Description |
---|---|
protected COSArray |
PreflightParser.parseCOSArray() |
Modifier and Type | Method and Description |
---|---|
(package private) void |
DestinationValidationProcess.validateExplicitDestination(PreflightContext ctx,
COSArray ar) |
Modifier and Type | Method and Description |
---|---|
static COSArray |
COSUtils.getAsArray(COSBase cbase,
COSDocument cDoc)
Return the COSBase object as COSArray if the COSBase object is an instance of COSArray or a reference to a
COSArray object.
|
Modifier and Type | Method and Description |
---|---|
COSArray |
Matrix.toCOSArray()
Returns a COS array which represent the geometric relevant
components of the matrix.
|
Constructor and Description |
---|
Matrix(COSArray array)
Creates a matrix from a 6-element (a b c d e f) COS array.
|