Uses of Class
org.apache.pdfbox.cos.COSArray

Packages that use COSArray

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.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.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.util	This package contains utility classes that are used by the PDFBox project.

Uses of COSArray in org.apache.pdfbox.contentstream

Methods in org.apache.pdfbox.contentstream with parameters of type COSArray

Modifier and Type	Method	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.

Uses of COSArray in org.apache.pdfbox.cos

Methods in org.apache.pdfbox.cos that return COSArray

Modifier and Type	Method	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.

Methods in org.apache.pdfbox.cos with parameters of type COSArray

Modifier and Type	Method	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.

Uses of COSArray in org.apache.pdfbox.pdfparser

Methods in org.apache.pdfbox.pdfparser that return COSArray

Modifier and Type	Method	Description
protected COSArray	BaseParser.parseCOSArray()	This will parse a PDF array object.

Uses of COSArray in org.apache.pdfbox.pdfwriter

Methods in org.apache.pdfbox.pdfwriter with parameters of type COSArray

Modifier and Type	Method	Description
java.lang.Object	COSWriter.visitFromArray(COSArray obj)

Uses of COSArray in org.apache.pdfbox.pdmodel

Methods in org.apache.pdfbox.pdmodel with parameters of type COSArray

Modifier and Type	Method	Description
void	PDAppearanceContentStream.setBorderLine(float lineWidth, PDBorderStyleDictionary bs, COSArray border)	Convenience method for annotations: sets the line with and dash style.

Uses of COSArray in org.apache.pdfbox.pdmodel.common

Methods in org.apache.pdfbox.pdmodel.common that return COSArray

Modifier and Type	Method	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	PDRange.getCOSArray()	This will get the underlying array value.
COSArray	PDRectangle.getCOSArray()	This will get the underlying array for this rectangle.
COSArray	COSArrayList.toList()	Deprecated. use COSArrayList.getCOSArray() instead.

Methods in org.apache.pdfbox.pdmodel.common with parameters of type COSArray

Modifier and Type	Method	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.

Constructors in org.apache.pdfbox.pdmodel.common with parameters of type COSArray

Constructor	Description
COSArrayList(java.util.List<E> actualList, COSArray cosArray)	Create the COSArrayList specifying the List and the backing COSArray.
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.

Uses of COSArray in org.apache.pdfbox.pdmodel.common.function

Methods in org.apache.pdfbox.pdmodel.common.function that return COSArray

Modifier and Type	Method	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 .
protected COSArray	PDFunctionTypeIdentity.getRangeValues()
COSArray	PDFunctionType0.getSize()	The "Size" entry, which is the number of samples in each input dimension of the sample table.

Methods in org.apache.pdfbox.pdmodel.common.function with parameters of type COSArray

Modifier and Type	Method	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.

Uses of COSArray in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure that return COSArray

Modifier and Type	Method	Description
COSArray	PDStructureTreeRoot.getKArray()	Deprecated. use PDStructureTreeRoot.getK() only.

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSArray

Constructor	Description
PDParentTreeValue(COSArray obj)

Uses of COSArray in org.apache.pdfbox.pdmodel.documentinterchange.prepress

Methods in org.apache.pdfbox.pdmodel.documentinterchange.prepress with parameters of type COSArray

Modifier and Type	Method	Description
void	PDBoxStyle.setLineDashPattern(COSArray dashArray)	Set the line dash pattern associated with this box style.

Uses of COSArray in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf with parameters of type COSArray

Constructor	Description
PDFourColours(COSArray array)

Uses of COSArray in org.apache.pdfbox.pdmodel.encryption

Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type COSArray

Modifier and Type	Method	Description
void	PublicKeySecurityHandler.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	StandardSecurityHandler.prepareForDecryption(PDEncryption encryption, COSArray documentIDArray, DecryptionMaterial decryptionMaterial)	Prepares everything to decrypt the document.

Uses of COSArray in org.apache.pdfbox.pdmodel.fdf

Methods in org.apache.pdfbox.pdmodel.fdf that return COSArray

Modifier and Type	Method	Description
COSArray	FDFOptionElement.getCOSArray()	Convert this standard java object to a COS object.
COSArray	FDFDictionary.getID()	This is the FDF id.

Methods in org.apache.pdfbox.pdmodel.fdf with parameters of type COSArray

Modifier and Type	Method	Description
void	FDFDictionary.setID(COSArray id)	This will set the FDF id.

Constructors in org.apache.pdfbox.pdmodel.fdf with parameters of type COSArray

Constructor	Description
FDFOptionElement(COSArray o)	Constructor.

Uses of COSArray in org.apache.pdfbox.pdmodel.font.encoding

Constructors in org.apache.pdfbox.pdmodel.font.encoding with parameters of type COSArray

Constructor	Description
DictionaryEncoding(COSName baseEncoding, COSArray differences)	Creates a new DictionaryEncoding for embedding.

Uses of COSArray in org.apache.pdfbox.pdmodel.graphics

Constructors in org.apache.pdfbox.pdmodel.graphics with parameters of type COSArray

Constructor	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.

Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.color

Fields in org.apache.pdfbox.pdmodel.graphics.color declared as COSArray

Modifier and Type	Field	Description
protected COSArray	PDColorSpace.array

Methods in org.apache.pdfbox.pdmodel.graphics.color that return COSArray

Modifier and Type	Method	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

Methods in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSArray

Modifier and Type	Method	Description
static PDICCBased	PDICCBased.create(COSArray iccArray, PDResources resources)	Creates a new ICC color space using the PDF array, optionally using a resource cache.

Constructors in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSArray

Constructor	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)	Deprecated. use PDDeviceN(COSArray, PDResources)
PDDeviceN(COSArray deviceN, PDResources resources)	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.
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)	Deprecated. user PDSeparation(COSArray, PDResources)
PDSeparation(COSArray separation, PDResources resources)	Creates a new Separation color space from a PDF color space array.
PDTristimulus(COSArray array)	Constructor from COS object.

Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.image

Methods in org.apache.pdfbox.pdmodel.graphics.image that return COSArray

Modifier and Type	Method	Description
COSArray	PDImageXObject.getColorKeyMask()	Returns the color key mask array associated with this image, or null if there is none.
COSArray	PDInlineImage.getColorKeyMask()	Deprecated. inline images don't have a color key mask.
COSArray	PDImage.getDecode()	Returns the decode array.
COSArray	PDImageXObject.getDecode()
COSArray	PDInlineImage.getDecode()

Methods in org.apache.pdfbox.pdmodel.graphics.image with parameters of type COSArray

Modifier and Type	Method	Description
void	PDImage.setDecode(COSArray decode)	Sets the decode array.
void	PDImageXObject.setDecode(COSArray decode)
void	PDInlineImage.setDecode(COSArray decode)

Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.shading

Methods in org.apache.pdfbox.pdmodel.graphics.shading that return COSArray

Modifier and Type	Method	Description
COSArray	PDShading.getBackground()	This will return the background.
COSArray	PDShadingType2.getCoords()	This will get the Coords values for this shading.
COSArray	PDShadingType1.getDomain()	This will get the optional Domain values of a function based shading.
COSArray	PDShadingType2.getDomain()	This will get the optional Domain values for this shading.
COSArray	PDShadingType2.getExtend()	This will get the optional Extend values for this shading.

Methods in org.apache.pdfbox.pdmodel.graphics.shading with parameters of type COSArray

Modifier and Type	Method	Description
void	PDShading.setBackground(COSArray newBackground)	This will set the background.
void	PDShadingType2.setCoords(COSArray newCoords)	Sets the Coords entry for this shading.
void	PDShadingType1.setDomain(COSArray newDomain)	Sets the optional Domain entry for the function based shading.
void	PDShadingType2.setDomain(COSArray newDomain)	Sets the optional Domain entry for this 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.

Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.state

Methods in org.apache.pdfbox.pdmodel.graphics.state that return COSArray

Modifier and Type	Method	Description
COSArray	PDSoftMask.getBackdropColor()	Returns the backdrop color.

Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.action

Methods in org.apache.pdfbox.pdmodel.interactive.action that return COSArray

Modifier and Type	Method	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

Methods in org.apache.pdfbox.pdmodel.interactive.action with parameters of type COSArray

Modifier and Type	Method	Description
void	PDActionResetForm.setFields(COSArray array)
void	PDActionSubmitForm.setFields(COSArray array)

Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.annotation

Methods in org.apache.pdfbox.pdmodel.interactive.annotation that return COSArray

Modifier and Type	Method	Description
COSArray	PDAnnotation.getBorder()	This will retrieve the border array.

Methods in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type COSArray

Modifier and Type	Method	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.

Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return COSArray

Modifier and Type	Method	Description
COSArray	PDFTemplateStructure.getProcSet()	Gets ProcSet Array

Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type COSArray

Modifier and Type	Method	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

Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination

Fields in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination declared as COSArray

Modifier and Type	Field	Description
protected COSArray	PDPageDestination.array	Storage for the page destination.

Methods in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination that return COSArray

Modifier and Type	Method	Description
COSArray	PDPageDestination.getCOSObject()	Convert this standard java object to a COS object.

Constructors in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination with parameters of type COSArray

Constructor	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.

Uses of COSArray in org.apache.pdfbox.util

Methods in org.apache.pdfbox.util that return COSArray

Modifier and Type	Method	Description
COSArray	Matrix.toCOSArray()	Returns a COS array which represent the geometric relevant components of the matrix.

Constructors in org.apache.pdfbox.util with parameters of type COSArray

Constructor	Description
Matrix(COSArray array)	Deprecated. use Matrix.createMatrix(COSBase) instead