| 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.examples.rendering | |
| 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.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.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.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.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.parser | |
| 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 |
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.
|
Object |
ICOSVisitor.visitFromArray(COSArray obj)
Notification of visit to Array object.
|
| Constructor and Description |
|---|
CSArrayBased(COSArray array) |
CSDeviceN(COSArray array)
Constructor
|
CSIndexed(COSArray array)
Constructor.
|
CSSeparation(COSArray array)
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
void |
CustomGraphicsStreamEngine.showTextStrings(COSArray array)
Overridden from PDFStreamEngine.
|
| Modifier and Type | Method and Description |
|---|---|
protected COSArray |
BaseParser.parseCOSArray()
This will parse a PDF array object.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
COSWriter.visitFromArray(COSArray obj) |
| Modifier and Type | Method and Description |
|---|---|
static COSArray |
COSArrayList.converterToCOSArray(List<?> cosObjectableList)
This will convert a list of COSObjectables to an array list of COSBase objects.
|
static COSArray |
COSArrayList.convertStringListToCOSNameCOSArray(List<String> strings)
This will take an list of string objects and return a COSArray of COSName
objects.
|
static COSArray |
COSArrayList.convertStringListToCOSStringCOSArray(List<String> strings)
This will take an list of string objects and return a COSArray of COSName
objects.
|
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()
This will return then underlying COSArray.
|
| Modifier and Type | Method and Description |
|---|---|
static List<String> |
COSArrayList.convertCOSNameCOSArrayToList(COSArray nameArray)
This will take an array of COSName and return a COSArrayList of
java.lang.String values.
|
static List<String> |
COSArrayList.convertCOSStringCOSArrayToList(COSArray stringArray)
This will take an array of COSString and return a COSArrayList of
java.lang.String values.
|
static List<Float> |
COSArrayList.convertFloatCOSArrayToList(COSArray floatArray)
This will take an array of COSNumbers and return a COSArrayList of
java.lang.Float values.
|
static List<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(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,
InputStream input,
COSArray filters)
Constructor.
|
| 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.
|
COSArray |
PDFunctionType3.getEncode()
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()
Returns the K array entry.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDBoxStyle.setLineDashPattern(COSArray dashArray)
Set the line dash pattern associated with this box style.
|
| Constructor and Description |
|---|
PDFourColours(COSArray array) |
| Modifier and Type | Method and Description |
|---|---|
void |
StandardSecurityHandler.prepareForDecryption(PDEncryption encryption,
COSArray documentIDArray,
DecryptionMaterial decryptionMaterial)
Prepares everything to decrypt the document.
|
abstract void |
SecurityHandler.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 | Method and Description |
|---|---|
COSArray |
FDFOptionElement.getCOSArray()
Convert this standard java object to a COS object.
|
COSArray |
FDFDictionary.getID()
This is the FDF id.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FDFDictionary.setID(COSArray id)
This will set the FDF id.
|
| Constructor and Description |
|---|
FDFOptionElement(COSArray o)
Constructor.
|
| Constructor and Description |
|---|
DictionaryEncoding(COSName baseEncoding,
COSArray differences)
Creates a new DictionaryEncoding for embedding.
|
| 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 |
| Modifier and Type | Method and Description |
|---|---|
COSArray |
PDGamma.getCOSArray()
Convert this standard java object to a COS object.
|
COSArray |
PDColor.toCOSArray()
Returns the color component values as a COS array
|
| 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)
Creates a new ICC color space using the PDF array.
|
PDIndexed(COSArray indexedArray)
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()
Returns the color key mask array associated with this image, or null if
there is none.
|
COSArray |
PDImageXObject.getColorKeyMask()
Returns the color key mask array associated with this image, or null if there is none.
|
COSArray |
PDInlineImage.getDecode() |
COSArray |
PDImageXObject.getDecode() |
COSArray |
PDImage.getDecode()
Returns the decode array.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDInlineImage.setDecode(COSArray decode) |
void |
PDImageXObject.setDecode(COSArray decode) |
void |
PDImage.setDecode(COSArray decode)
Sets the decode array.
|
| 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.
|
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 |
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 | Method and Description |
|---|---|
COSArray |
PDSoftMask.getBackdropColor()
Returns the backdrop color.
|
| Modifier and Type | Method and Description |
|---|---|
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
|
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
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDActionSubmitForm.setFields(COSArray array) |
void |
PDActionResetForm.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 |
|---|---|
COSArray |
PDFTemplateStructure.getProcSet()
Gets ProcSet Array
|
| Modifier and Type | Method and Description |
|---|---|
void |
PDVisibleSigBuilder.injectProcSetArray(PDFormXObject innerForm,
PDPage page,
PDResources innerFormResources,
PDResources imageFormResources,
PDResources holderFormResources,
COSArray procSet) |
void |
PDFTemplateBuilder.injectProcSetArray(PDFormXObject innerForm,
PDPage page,
PDResources innerFormResources,
PDResources imageFormResources,
PDResources holderFormResources,
COSArray procSet)
Inject procSetArray
|
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 |
|---|---|
protected COSArray |
PreflightParser.parseCOSArray() |
| 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 represents this matrix.
|
| Constructor and Description |
|---|
Matrix(COSArray array)
Creates a matrix from a 6-element COS array.
|
Copyright © 2002–2016 The Apache Software Foundation. All rights reserved.