Uses of Class
org.apache.pdfbox.cos.COSBase
Packages that use COSBase
Package
Description
This package contains provides classes for working with content streams.
This package contains implementations of all of the PDF operators.
This package contains implementations of all of the PDF graphics operators.
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.
The file specification package defines classes that are used for the PDF File Specification logic.
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.
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 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 destination package allows destinations into a pdf document to be specified.
The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".
A package to allow provide access to PDF page navigation functionality.
This package contains utility classes that are used by the PDFBox project.
-
Uses of COSBase in org.apache.pdfbox.contentstream
Method parameters in org.apache.pdfbox.contentstream with type arguments of type COSBaseModifier and TypeMethodDescriptionprotected void
PDFStreamEngine.operatorException
(Operator operator, List<COSBase> operands, IOException e) Called when an exception is thrown by an operator.void
PDFStreamEngine.processOperator
(String operation, List<COSBase> arguments) This is used to handle an operation.protected void
PDFStreamEngine.processOperator
(Operator operator, List<COSBase> operands) This is used to handle an operation.protected void
PDFStreamEngine.unsupportedOperator
(Operator operator, List<COSBase> operands) Called when an unsupported operator is encountered. -
Uses of COSBase in org.apache.pdfbox.contentstream.operator
Method parameters in org.apache.pdfbox.contentstream.operator with type arguments of type COSBaseModifier and TypeMethodDescriptionboolean
OperatorProcessor.checkArrayTypesClass
(List<COSBase> operands, Class<?> clazz) Check whether all operands list elements are an instance of a specific class.void
abstract void
Process the operator.Constructor parameters in org.apache.pdfbox.contentstream.operator with type arguments of type COSBase -
Uses of COSBase in org.apache.pdfbox.contentstream.operator.color
Method parameters in org.apache.pdfbox.contentstream.operator.color with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
RG Set the stroking colour space to DeviceRGB and set the colour to use for stroking operations. -
Uses of COSBase in org.apache.pdfbox.contentstream.operator.graphics
Method parameters in org.apache.pdfbox.contentstream.operator.graphics with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
final void
void
void
void
void
-
Uses of COSBase in org.apache.pdfbox.contentstream.operator.markedcontent
Method parameters in org.apache.pdfbox.contentstream.operator.markedcontent with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
void
void
void
-
Uses of COSBase in org.apache.pdfbox.contentstream.operator.state
Method parameters in org.apache.pdfbox.contentstream.operator.state with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
-
Uses of COSBase in org.apache.pdfbox.contentstream.operator.text
Method parameters in org.apache.pdfbox.contentstream.operator.text with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
-
Uses of COSBase in org.apache.pdfbox.cos
Subclasses of COSBase in org.apache.pdfbox.cosModifier and TypeClassDescriptionclass
An array of PDFBase objects as part of the PDF document.final class
This class represents a boolean value in the PDF document.class
This class represents a dictionary where name/value pairs reside.class
This is the in-memory representation of the PDF document.class
This class represents a floating point number in a PDF document.final class
This class represents an integer number in a PDF document.final class
A PDF Name object.final class
This class represents a null PDF object.class
This class represents an abstract number in a PDF document.class
This class represents a PDF object.class
This class represents a stream object in a PDF document.final class
A string object, which may be a text string, a PDFDocEncoded string, ASCII string, or byte string.Fields in org.apache.pdfbox.cos with type parameters of type COSBaseMethods in org.apache.pdfbox.cos that return COSBaseModifier and TypeMethodDescriptionCOSArray.get
(int index) This will get an object from the array.COSBase.getCOSObject()
Convert this standard java object to a COS object.COSDictionary.getDictionaryObject
(String key) This will get an object from this dictionary.COSDictionary.getDictionaryObject
(String[] keyList) Deprecated.Will be removed in 3.0.COSDictionary.getDictionaryObject
(COSName key) This will get an object from this dictionary.COSDictionary.getDictionaryObject
(COSName firstKey, COSName secondKey) 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.COSObject.getDictionaryObject
(COSName key) 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.COSStream.getFilters()
This will return the filters to apply to the byte stream.This will do a lookup into the dictionary.This will do a lookup into the dictionary.This is a special case of getItem 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.This will get the dictionary object in this object that has the name key.COSArray.getObject
(int index) This will get an object from the array.COSObject.getObject()
This will get the object that this object encapsulates.COSDictionary.getObjectFromPath
(String objPath) Nice method, gives you every object you want Arrays works properly too.COSArray.remove
(int i) This will remove an element from the array.Methods in org.apache.pdfbox.cos that return types with arguments of type COSBaseModifier and TypeMethodDescriptionCOSDictionary.entrySet()
Returns the name-value entries in this dictionary.COSDictionary.getValues()
This will get all of the values for the dictionary.COSArray.iterator()
Get access to the list.COSArray.toList()
Return contents of COSArray as a Java List.Methods in org.apache.pdfbox.cos with parameters of type COSBaseModifier and TypeMethodDescriptionvoid
Add the specified object at the ith location and push the rest to the right.void
This will add an object to the array.COSStream.createOutputStream
(COSBase filters) Returns a new OutputStream for writing stream data, using and the given filters.Returns the COSObjectKey for a given COS object, or null if there is none.void
COSArray.growToSize
(int size, COSBase object) This will add the object until the size of the array is at least as large as the parameter.int
This will return the index of the entry or -1 if it is not found.int
COSArray.indexOfObject
(COSBase object) This will return the index of the entry or -1 if it is not found.boolean
This will remove an element from the array.boolean
COSArray.removeObject
(COSBase o) This will remove an element from the array.void
This will set an object at a specific index.void
COSStream.setFilters
(COSBase filters) Deprecated.UseCOSStream.createOutputStream(COSBase)
instead.void
This will set an item in the dictionary.void
This will set an item in the dictionary.final void
This will set the object that this object encapsulates.Method parameters in org.apache.pdfbox.cos with type arguments of type COSBaseModifier and TypeMethodDescriptionvoid
COSArray.addAll
(int i, Collection<COSBase> objectList) Add the specified object at the ith location and push the rest to the right.void
COSArray.addAll
(Collection<COSBase> objectsList) This will add an object to the array.void
COSArray.removeAll
(Collection<COSBase> objectsList) This will remove all of the objects in the collection.void
COSArray.retainAll
(Collection<COSBase> objectsList) This will retain all of the objects in the collection.Constructors in org.apache.pdfbox.cos with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.multipdf
Methods in org.apache.pdfbox.multipdf that return COSBaseModifier and TypeMethodDescriptionPDFCloneUtility.cloneForNewDocument
(Object base) Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter. -
Uses of COSBase in org.apache.pdfbox.pdfparser
Methods in org.apache.pdfbox.pdfparser that return COSBaseModifier and TypeMethodDescriptionprotected COSBase
BaseParser.parseDirObject()
This will parse a directory object from the stream.protected COSBase
COSParser.parseObjectDynamically
(long objNr, int objGenNr, boolean requireExistingNotCompressedObj) This will parse the next object from the stream and add it to the local state.protected final COSBase
COSParser.parseObjectDynamically
(COSObject obj, boolean requireExistingNotCompressedObj) This will parse the next object from the stream and add it to the local state.protected COSBase
COSParser.parseTrailerValuesDynamically
(COSDictionary trailer) Parse the values of the trailer dictionary and return the root object. -
Uses of COSBase in org.apache.pdfbox.pdfwriter
Methods in org.apache.pdfbox.pdfwriter that return COSBaseMethods in org.apache.pdfbox.pdfwriter that return types with arguments of type COSBaseModifier and TypeMethodDescriptionCOSWriter.getObjectKeys()
This will get all available object keys.Methods in org.apache.pdfbox.pdfwriter with parameters of type COSBaseModifier and TypeMethodDescriptionvoid
COSWriter.doWriteObject
(COSBase obj) This will write a COS object.void
COSWriter.writeReference
(COSBase obj) visitFromObjRef method comment.void
ContentStreamWriter.writeToken
(COSBase base) Writes a single operand token.Constructors in org.apache.pdfbox.pdfwriter with parameters of type COSBaseModifierConstructorDescriptionCOSWriterXRefEntry
(long start, COSBase obj, COSObjectKey keyValue) Constructor. -
Uses of COSBase in org.apache.pdfbox.pdmodel
Methods in org.apache.pdfbox.pdmodel that return COSBaseModifier and TypeMethodDescriptionstatic COSBase
PDPageTree.getInheritableAttribute
(COSDictionary node, COSName key) Returns the given attribute, inheriting from parent tree nodes if necessary.Methods in org.apache.pdfbox.pdmodel with parameters of type COSBaseModifier and TypeMethodDescriptionprotected PDPageDestination
PDDestinationNameTreeNode.convertCOSToPD
(COSBase base) protected PDComplexFileSpecification
PDEmbeddedFilesNameTreeNode.convertCOSToPD
(COSBase base) protected PDActionJavaScript
PDJavascriptNameTreeNode.convertCOSToPD
(COSBase base) protected PDStructureElement
PDStructureElementNameTreeNode.convertCOSToPD
(COSBase base) -
Uses of COSBase in org.apache.pdfbox.pdmodel.common
Methods in org.apache.pdfbox.pdmodel.common that return COSBaseModifier and TypeMethodDescriptionCOSObjectable.getCOSObject()
Convert this standard java object to a COS object.PDPageLabels.getCOSObject()
Convert this standard java object to a COS object.PDRange.getCOSObject()
Convert this standard java object to a COS object.PDRectangle.getCOSObject()
Convert this standard java object to a COS object.Methods in org.apache.pdfbox.pdmodel.common with parameters of type COSBaseModifier and TypeMethodDescriptionprotected abstract T
PDNameTreeNode.convertCOSToPD
(COSBase base) Method to convert the COS value in the name tree to the PD Model object.protected COSObjectable
PDNumberTreeNode.convertCOSToPD
(COSBase base) Method to convert the COS value in the number tree to the PD Model object.Constructors in org.apache.pdfbox.pdmodel.common with parameters of type COSBaseModifierConstructorDescriptionCOSArrayList
(E actualObject, COSBase item, COSDictionary dictionary, COSName dictionaryKey) This is a really special constructor. -
Uses of COSBase in org.apache.pdfbox.pdmodel.common.filespecification
Methods in org.apache.pdfbox.pdmodel.common.filespecification that return COSBaseModifier and TypeMethodDescriptionPDSimpleFileSpecification.getCOSObject()
Convert this standard java object to a COS object.Methods in org.apache.pdfbox.pdmodel.common.filespecification with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDFileSpecification
A file specification can either be a COSString or a COSDictionary. -
Uses of COSBase in org.apache.pdfbox.pdmodel.common.function
Methods in org.apache.pdfbox.pdmodel.common.function with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDFunction
Create the correct PD Model function based on the COS base function.Constructors in org.apache.pdfbox.pdmodel.common.function with parameters of type COSBaseModifierConstructorDescriptionPDFunction
(COSBase function) Constructor.PDFunctionType0
(COSBase function) Constructor.PDFunctionType2
(COSBase function) Constructor.PDFunctionType3
(COSBase functionStream) Constructor.PDFunctionType4
(COSBase functionStream) Constructor.PDFunctionTypeIdentity
(COSBase function) -
Uses of COSBase in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure that return COSBaseModifier and TypeMethodDescriptionPDDefaultAttributeObject.getAttributeValue
(String attrName) Gets the attribute value for a given name.protected COSBase
PDDefaultAttributeObject.getAttributeValue
(String attrName, COSBase defaultValue) Gets the attribute value for a given name.PDParentTreeValue.getCOSObject()
PDStructureTreeRoot.getK()
Returns the K entry.PDUserProperty.getValue()
Returns the property value.Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSBaseModifier and TypeMethodDescriptionprotected void
Appends a COS base kid.protected Object
PDStructureNode.createObject
(COSBase kid) Creates an object for a kid of this structure node.protected COSBase
PDDefaultAttributeObject.getAttributeValue
(String attrName, COSBase defaultValue) Gets the attribute value for a given name.protected void
PDStructureNode.insertBefore
(COSBase newKid, Object refKid) Inserts an COS base kid before a reference kid.protected void
PDAttributeObject.potentiallyNotifyChanged
(COSBase oldBase, COSBase newBase) Notifies the attribute object change listeners if the attribute is changed.protected boolean
Removes a COS base kid.void
PDDefaultAttributeObject.setAttribute
(String attrName, COSBase attrValue) Sets an attribute.void
Sets the K entry.void
Sets the property value. -
Uses of COSBase in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
Methods in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf that return COSBaseModifier and TypeMethodDescriptionPDFourColours.getCOSObject()
Convert this standard java object to a COS object. -
Uses of COSBase in org.apache.pdfbox.pdmodel.encryption
Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.pdmodel.fdf
Methods in org.apache.pdfbox.pdmodel.fdf that return COSBaseModifier and TypeMethodDescriptionFDFOptionElement.getCOSObject()
Convert this standard java object to a COS object.FDFField.getCOSValue()
Returns the COS value of this field.Methods in org.apache.pdfbox.pdmodel.fdf with parameters of type COSBaseModifier and TypeMethodDescriptionprotected final String
FDFAnnotation.getStringOrStream
(COSBase base) Get a text or text stream.void
Sets the COS value of this field. -
Uses of COSBase in org.apache.pdfbox.pdmodel.font
Methods in org.apache.pdfbox.pdmodel.font that return COSBaseMethods in org.apache.pdfbox.pdmodel.font with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.pdmodel.font.encoding
Methods in org.apache.pdfbox.pdmodel.font.encoding that return COSBaseModifier and TypeMethodDescriptionBuiltInEncoding.getCOSObject()
DictionaryEncoding.getCOSObject()
MacExpertEncoding.getCOSObject()
MacOSRomanEncoding.getCOSObject()
MacRomanEncoding.getCOSObject()
StandardEncoding.getCOSObject()
SymbolEncoding.getCOSObject()
Type1Encoding.getCOSObject()
WinAnsiEncoding.getCOSObject()
ZapfDingbatsEncoding.getCOSObject()
-
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics
Methods in org.apache.pdfbox.pdmodel.graphics that return COSBaseModifier and TypeMethodDescriptionPDFontSetting.getCOSObject()
Convert this standard java object to a COS object.PDLineDashPattern.getCOSObject()
Methods in org.apache.pdfbox.pdmodel.graphics with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDXObject
PDXObject.createXObject
(COSBase base, PDResources resources) Creates a new XObject instance of the appropriate type for the COS stream. -
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics.blend
Methods in org.apache.pdfbox.pdmodel.graphics.blend with parameters of type COSBaseModifier and TypeMethodDescriptionstatic BlendMode
BlendMode.getInstance
(COSBase cosBlendMode) Determines the blend mode from the BM entry in the COS ExtGState. -
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics.color
Methods in org.apache.pdfbox.pdmodel.graphics.color that return COSBaseModifier and TypeMethodDescriptionPDColorSpace.getCOSObject()
PDDeviceColorSpace.getCOSObject()
PDGamma.getCOSObject()
Convert this standard java object to a COS object.PDJPXColorSpace.getCOSObject()
PDOutputIntent.getCOSObject()
PDSpecialColorSpace.getCOSObject()
PDTristimulus.getCOSObject()
Convert this standard java object to a COS object.Methods in org.apache.pdfbox.pdmodel.graphics.color with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDColorSpace
Creates a color space given a name or array.static PDColorSpace
PDColorSpace.create
(COSBase colorSpace, PDResources resources) Creates a color space given a name or array.static PDColorSpace
PDColorSpace.create
(COSBase colorSpace, PDResources resources, boolean wasDefault) Creates a color space given a name or array. -
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics.image
Methods in org.apache.pdfbox.pdmodel.graphics.image that return COSBaseConstructors in org.apache.pdfbox.pdmodel.graphics.image with parameters of type COSBaseModifierConstructorDescriptionPDImageXObject
(PDDocument document, InputStream encodedStream, COSBase cosFilter, int width, int height, int bitsPerComponent, PDColorSpace initColorSpace) Creates an Image XObject in the given document using the given filtered stream. -
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics.state
Methods in org.apache.pdfbox.pdmodel.graphics.state that return COSBaseModifier and TypeMethodDescriptionPDExtendedGraphicsState.getTransfer()
This will get the transfer function of the /TR dictionary.PDGraphicsState.getTransfer()
This will get the transfer function.PDExtendedGraphicsState.getTransfer2()
This will get the transfer function of the /TR2 dictionary.Methods in org.apache.pdfbox.pdmodel.graphics.state with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDSoftMask
Creates a new soft mask.void
PDExtendedGraphicsState.setTransfer
(COSBase transfer) This will set the transfer function of the /TR dictionary.void
PDGraphicsState.setTransfer
(COSBase transfer) This will set the transfer function.void
PDExtendedGraphicsState.setTransfer2
(COSBase transfer2) This will set the transfer function of the /TR2 dictionary. -
Uses of COSBase in org.apache.pdfbox.pdmodel.interactive.action
Methods in org.apache.pdfbox.pdmodel.interactive.action that return COSBaseModifier and TypeMethodDescriptionPDActionThread.getB()
PDActionRemoteGoTo.getD()
This will get the destination to jump to.PDActionThread.getD()
PDActionHide.getT()
The annotation or annotations to be hidden or shownMethods in org.apache.pdfbox.pdmodel.interactive.action with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.pdmodel.interactive.annotation
Methods in org.apache.pdfbox.pdmodel.interactive.annotation that return COSBaseMethods in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDAnnotation
PDAnnotation.createAnnotation
(COSBase base) Create the correct annotation from the base COS object.Constructors in org.apache.pdfbox.pdmodel.interactive.annotation with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.pdmodel.interactive.form
Methods in org.apache.pdfbox.pdmodel.interactive.form that return COSBaseModifier and TypeMethodDescriptionPDXFAResource.getCOSObject()
Convert this standard java object to a COS object.PDNonTerminalField.getDefaultValue()
Returns the default value of this field.protected COSBase
PDField.getInheritableAttribute
(COSName key) Returns the given attribute, inheriting from parent nodes if necessary.PDNonTerminalField.getValue()
Get the field value.Methods in org.apache.pdfbox.pdmodel.interactive.form with parameters of type COSBaseModifier and TypeMethodDescriptionprotected final String
PDVariableText.getStringOrStream
(COSBase base) Get a text as text stream.void
PDNonTerminalField.setDefaultValue
(COSBase value) Sets the default of this field.void
Sets the value of this field.Constructors in org.apache.pdfbox.pdmodel.interactive.form with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.util
Methods in org.apache.pdfbox.util with parameters of type COSBaseModifier and TypeMethodDescriptionstatic Matrix
Matrix.createMatrix
(COSBase base) Convenience method to be used when creating a matrix from unverified data.