Uses of Class
org.apache.pdfbox.cos.COSArray
Packages that use COSArray
Package
Description
This package contains provides classes for working with content streams.
These are the low level objects that make up a PDF document.
The pdfparser package contains classes to parse PDF documents and objects within the document.
This is the persistence layer used to write the PDFBox documents to a stream.
The PDModel package represents a high level API for creating and manipulating PDF documents.
High level PD classes that are used throughout several packages are placed in the PDModel common package.
This package contains functions that are available in the PDF specification.
The logical structure package provides a mechanism for incorporating
structural information about a document's content into a PDF file.
This package contains classes for prepress support in PDFBox.
The tagged PDF package provides a mechanism for incorporating "tags" (standard
structure types and attributes) into a PDF file.
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
Classes to deal with font functionality in a PDF Document.
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
This package deals with colors that are stored in a PDF document.
This package deals with images that are stored in a PDF document.
This package deals with shadings which are used for filling instead of a color.
This package deals with graphics states within the PDF document.
This package represents actions that can be performed in a PDF document.
The annotation package contains classes that work with PDF annotation elements.
The digital signature library will manage signatures that are stored in the PDF document.
This is the visual signature part that help creating the visual representation for the digital signature.
The destination package allows destinations into a pdf document to be specified.
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 COSArrayModifier and TypeMethodDescriptionvoid
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 COSArrayModifier and TypeMethodDescriptionCOSDictionary.getCOSArray
(COSName key) This is a convenience method that will get the dictionary object that is expected to be a COSArray.COSDocument.getDocumentID()
This will get the document ID.Methods in org.apache.pdfbox.cos with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
This will add all objects to this array.void
COSDocument.setDocumentID
(COSArray id) This will set the document ID.ICOSVisitor.visitFromArray
(COSArray obj) Notification of visit to Array object. -
Uses of COSArray in org.apache.pdfbox.debugger.colorpane
Methods in org.apache.pdfbox.debugger.colorpane with parameters of type COSArrayConstructors in org.apache.pdfbox.debugger.colorpane with parameters of type COSArrayModifierConstructorDescriptionCSArrayBased
(COSArray array) ConstructorConstructor.CSSeparation
(COSArray array) Constructor -
Uses of COSArray in org.apache.pdfbox.multipdf
Methods in org.apache.pdfbox.multipdf with parameters of type COSArrayModifier and TypeMethodDescriptionprivate void
Overlay.addOriginalContent
(COSBase contents, COSArray contentArray) private boolean
PDFMergerUtility.hasOnlyDocumentsOrParts
(COSArray kLevelOneArray) private void
Overlay.overlayPage
(PDPage page, Overlay.LayoutPage layoutPage, COSArray array) private void
PDFMergerUtility.updatePageReferences
(PDFCloneUtility cloner, COSArray parentTreeEntry, Map<COSDictionary, COSDictionary> objMapping) private void
PDFMergerUtility.updateParentEntry
(COSArray kArray, COSDictionary newParent, COSName newStructureType) Update the P reference to the new parent dictionary. -
Uses of COSArray in org.apache.pdfbox.pdfparser
Methods in org.apache.pdfbox.pdfparser that return COSArrayModifier and TypeMethodDescriptionprotected COSArray
BaseParser.parseCOSArray()
This will parse a PDF array object.Constructors in org.apache.pdfbox.pdfparser with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdfwriter
Fields in org.apache.pdfbox.pdfwriter declared as COSArrayMethods in org.apache.pdfbox.pdfwriter with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel
Methods in org.apache.pdfbox.pdmodel with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
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
Fields in org.apache.pdfbox.pdmodel.common declared as COSArrayModifier and TypeFieldDescriptionprivate final COSArray
COSArrayList.array
private COSArray
PDRange.rangeArray
private final COSArray
PDRectangle.rectArray
Methods in org.apache.pdfbox.pdmodel.common that return COSArrayModifier and TypeMethodDescriptionstatic 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.COSArrayList.getCOSArray()
This will return the underlying COSArray.PDRange.getCOSArray()
This will get the underlying array value.PDRectangle.getCOSArray()
This will get the underlying array for this rectangle.COSArrayList.toList()
Deprecated.Methods in org.apache.pdfbox.pdmodel.common with parameters of type COSArrayModifier and TypeMethodDescriptionCOSArrayList.convertCOSNameCOSArrayToList
(COSArray nameArray) This will take an array of COSName and return a COSArrayList of java.lang.String values.COSArrayList.convertCOSStringCOSArrayToList
(COSArray stringArray) This will take an array of COSString and return a COSArrayList of java.lang.String values.COSArrayList.convertFloatCOSArrayToList
(COSArray floatArray) This will take an array of COSNumbers and return a COSArrayList of java.lang.Float values.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 COSArrayModifierConstructorDescriptionCOSArrayList
(List<E> actualList, COSArray cosArray) Create the COSArrayList specifying the List and the backing COSArray.Constructor assumes a starting index of 0.Constructor with an index into an array.PDRectangle
(COSArray array) Constructor.PDStream
(PDDocument doc, InputStream input, COSArray filters) Constructor. -
Uses of COSArray in org.apache.pdfbox.pdmodel.common.function
Fields in org.apache.pdfbox.pdmodel.common.function declared as COSArrayModifier and TypeFieldDescriptionprivate COSArray
PDFunctionType3.bounds
private final COSArray
PDFunctionType2.c0
The C0 values of the exponential function.private final 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
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.encode
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.Methods in org.apache.pdfbox.pdmodel.common.function that return COSArrayModifier and TypeMethodDescriptionDeprecated.Replaced byPDFunction.eval(float[] input)
PDFunctionType3.getBounds()
Returns all bounds values as COSArray.PDFunctionType2.getC0()
Returns the C0 values of the function, 0 if empty.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.PDFunctionType3.getEncode()
Returns all encode values as COSArray.private COSArray
PDFunctionType0.getEncodeValues()
Returns all encode values as 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()
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 COSArrayModifier and TypeMethodDescriptionDeprecated.Replaced byPDFunction.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 COSArrayModifier and TypeMethodDescriptionPDStructureTreeRoot.getKArray()
Deprecated.usePDStructureTreeRoot.getK()
only.Constructors in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.documentinterchange.prepress
Methods in org.apache.pdfbox.pdmodel.documentinterchange.prepress with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
PDBoxStyle.setLineDashPattern
(COSArray dashArray) Set the line dash pattern associated with this box style. -
Uses of COSArray in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
Fields in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf declared as COSArrayConstructors in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.encryption
Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type COSArrayModifier and TypeMethodDescriptionprivate void
SecurityHandler.decryptArray
(COSArray array, long objNum, long genNum) This will decrypt an array.private byte[]
StandardSecurityHandler.getDocumentIDBytes
(COSArray documentIDArray) 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
Fields in org.apache.pdfbox.pdmodel.fdf declared as COSArrayMethods in org.apache.pdfbox.pdmodel.fdf that return COSArrayModifier and TypeMethodDescriptionFDFOptionElement.getCOSArray()
Convert this standard java object to a COS object.FDFDictionary.getID()
This is the FDF id.private COSArray
FDFAnnotationStamp.parseArrayElement
(Element arrayEl) Methods in org.apache.pdfbox.pdmodel.fdf with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
This will set the FDF id.Constructors in org.apache.pdfbox.pdmodel.fdf with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.font
Methods in org.apache.pdfbox.pdmodel.font that return COSArrayModifier and TypeMethodDescriptionprivate COSArray
PDCIDFontType2Embedder.getVerticalMetrics
(int[] values) private COSArray
PDCIDFontType2Embedder.getWidths
(int[] widths) Methods in org.apache.pdfbox.pdmodel.font with parameters of type COSArrayModifier and TypeMethodDescriptionprivate boolean
PDType3Font.checkFontMatrixValues
(COSArray matrix) -
Uses of COSArray in org.apache.pdfbox.pdmodel.font.encoding
Constructors in org.apache.pdfbox.pdmodel.font.encoding with parameters of type COSArrayModifierConstructorDescriptionDictionaryEncoding
(COSName baseEncoding, COSArray differences) Creates a new DictionaryEncoding for embedding. -
Uses of COSArray in org.apache.pdfbox.pdmodel.graphics
Fields in org.apache.pdfbox.pdmodel.graphics declared as COSArrayConstructors in org.apache.pdfbox.pdmodel.graphics with parameters of type COSArrayModifierConstructorDescriptionConstructs 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 COSArrayModifier and TypeFieldDescriptionprotected COSArray
PDColorSpace.array
private final COSArray
PDGamma.values
private final COSArray
PDTristimulus.values
Methods in org.apache.pdfbox.pdmodel.graphics.color that return COSArrayModifier and TypeMethodDescriptionPDGamma.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).PDColor.toCOSArray()
Returns the color component values as a COS arrayMethods in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSArrayModifier and TypeMethodDescriptionprivate 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.Constructors in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSArrayModifierConstructorDescriptionCreates a new CalGray color space using the given COS array.Creates a new CalRGB color space using the given COS array.protected
Creates a new CalRGB color space using the given COS array.PDColor
(COSArray array, PDColorSpace colorSpace) Creates a PDColor containing the given color value.Creates a new DeviceN color space from the given COS array.Creates a new gamma from a COS array.PDICCBased
(COSArray iccArray) Deprecated.This will be private in 3.0.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.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. -
Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.image
Methods in org.apache.pdfbox.pdmodel.graphics.image that return COSArrayModifier and TypeMethodDescriptionPDImageXObject.getColorKeyMask()
Returns the color key mask array associated with this image, or null if there is none.PDInlineImage.getColorKeyMask()
Deprecated.inline images don't have a color key mask.PDImage.getDecode()
Returns the decode array.PDImageXObject.getDecode()
PDInlineImage.getDecode()
Methods in org.apache.pdfbox.pdmodel.graphics.image with parameters of type COSArrayModifier and TypeMethodDescriptionprivate static BufferedImage
SampledImageReader.fromAny
(PDImage pdImage, WritableRaster raster, COSArray colorKey, Rectangle clipped, int subsampling, int width, int height) static BufferedImage
SampledImageReader.getRGBImage
(PDImage pdImage, Rectangle region, int subsampling, COSArray colorKey) Returns the content of the given image as a newly created AWT buffered image with an RGB color space.static BufferedImage
SampledImageReader.getRGBImage
(PDImage pdImage, COSArray colorKey) Returns the content of the given image as an AWT buffered image with an RGB color space.void
Sets the decode array.void
void
-
Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.optionalcontent
Methods in org.apache.pdfbox.pdmodel.graphics.optionalcontent that return COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.graphics.shading
Fields in org.apache.pdfbox.pdmodel.graphics.shading declared as COSArrayModifier and TypeFieldDescriptionprivate COSArray
PDShading.background
private COSArray
PDShadingType2.coords
private COSArray
PDTriangleBasedShadingType.decode
private COSArray
PDShadingType1.domain
private COSArray
PDShadingType2.domain
private COSArray
PDShadingType2.extend
Methods in org.apache.pdfbox.pdmodel.graphics.shading that return COSArrayModifier and TypeMethodDescriptionPDShading.getBackground()
This will return the background.PDShadingType2.getCoords()
This will get the Coords values for this shading.private COSArray
PDTriangleBasedShadingType.getDecodeValues()
Returns all decode values as COSArray.PDShadingType1.getDomain()
This will get the optional Domain values of a function based shading.PDShadingType2.getDomain()
This will get the optional Domain values for this shading.PDShadingType2.getExtend()
This will get the optional Extend values for this shading.Methods in org.apache.pdfbox.pdmodel.graphics.shading with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
PDShading.setBackground
(COSArray newBackground) This will set the background.void
Sets the Coords entry for this shading.void
PDTriangleBasedShadingType.setDecodeValues
(COSArray decodeValues) This will set the decode values.void
Sets the optional Domain entry for the function based shading.void
Sets the optional Domain entry for this shading.void
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
Fields in org.apache.pdfbox.pdmodel.graphics.state declared as COSArrayMethods in org.apache.pdfbox.pdmodel.graphics.state that return COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.action
Methods in org.apache.pdfbox.pdmodel.interactive.action that return COSArrayModifier and TypeMethodDescriptionPDActionResetForm.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 entryPDActionSubmitForm.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 entryMethods in org.apache.pdfbox.pdmodel.interactive.action with parameters of type COSArray -
Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.annotation
Methods in org.apache.pdfbox.pdmodel.interactive.annotation that return COSArrayMethods in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
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
Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature that return COSArrayModifier and TypeMethodDescriptionprivate static COSArray
PDSeedValueCertificate.convertListOfByteArraysToCOSArray
(List<byte[]> strings) Methods in org.apache.pdfbox.pdmodel.interactive.digitalsignature with parameters of type COSArrayModifier and TypeMethodDescriptionprivate static List<byte[]>
PDSeedValueCertificate.getListOfByteArraysFromCOSArray
(COSArray array) -
Uses of COSArray in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
Fields in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible declared as COSArrayMethods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible that return COSArrayMethods in org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible with parameters of type COSArrayModifier and TypeMethodDescriptionvoid
PDFTemplateBuilder.injectProcSetArray
(PDFormXObject innerForm, PDPage page, PDResources innerFormResources, PDResources imageFormResources, PDResources holderFormResources, COSArray procSet) Inject procSetArrayvoid
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.preflight.action
Methods in org.apache.pdfbox.preflight.action with parameters of type COSArrayModifier and TypeMethodDescriptionprivate boolean
GoToRemoteAction.validateExplicitDestination
(COSArray ar) -
Uses of COSArray in org.apache.pdfbox.preflight.parser
Methods in org.apache.pdfbox.preflight.parser that return COSArray -
Uses of COSArray in org.apache.pdfbox.preflight.process.reflect
Methods in org.apache.pdfbox.preflight.process.reflect with parameters of type COSArrayModifier and TypeMethodDescription(package private) void
DestinationValidationProcess.validateExplicitDestination
(PreflightContext ctx, COSArray ar) -
Uses of COSArray in org.apache.pdfbox.preflight.utils
Methods in org.apache.pdfbox.preflight.utils that return COSArrayModifier and TypeMethodDescriptionstatic 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. -
Uses of COSArray in org.apache.pdfbox.util
Methods in org.apache.pdfbox.util that return COSArrayModifier and TypeMethodDescriptionMatrix.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
COSArrayList.getCOSArray()
instead.