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.(package private) final class
An unmodifiable COSDictionary.Fields in org.apache.pdfbox.cos declared as COSBaseFields in org.apache.pdfbox.cos with type parameters of type COSBaseModifier and TypeFieldDescriptionCOSDictionary.items
The name-value pairs of this dictionary.COSArray.objects
Methods 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.private static String
COSDictionary.getDictionaryString
(COSBase base, List<COSBase> objs) 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.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.private static String
COSDictionary.getDictionaryString
(COSBase base, List<COSBase> objs) 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.debugger.ui
Fields in org.apache.pdfbox.debugger.ui declared as COSBaseModifier and TypeFieldDescriptionprivate COSBase
ArrayEntry.item
private COSBase
MapEntry.item
private COSBase
ArrayEntry.value
private COSBase
MapEntry.value
Methods in org.apache.pdfbox.debugger.ui that return COSBaseModifier and TypeMethodDescriptionArrayEntry.getItem()
This will get the value for this entry.MapEntry.getItem()
This will get the value for this entry.ArrayEntry.getValue()
This will get the value for this entry.MapEntry.getValue()
This will get the value for this entry.Methods in org.apache.pdfbox.debugger.ui with parameters of type COSBaseModifier and TypeMethodDescriptionvoid
This will set the value for this entry.void
This will set the value for this entry.void
This will set the value for this entry.void
This will set the value for this entry. -
Uses of COSBase in org.apache.pdfbox.multipdf
Fields in org.apache.pdfbox.multipdf with type parameters of type COSBaseMethods 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.Methods in org.apache.pdfbox.multipdf with parameters of type COSBaseModifier and TypeMethodDescriptionprivate void
Overlay.addOriginalContent
(COSBase contents, COSArray contentArray) private void
PDFCloneUtility.checkForRecursion
(Object parent, COSBase value) Check whether an element (of an array or a dictionary) points to its parent.private COSStream
Overlay.createCombinedContentStream
(COSBase contents) Overlay.createContentStreamList
(COSBase contents) -
Uses of COSBase in org.apache.pdfbox.pdfparser
Methods in org.apache.pdfbox.pdfparser that return COSBaseModifier and TypeMethodDescriptionprivate COSBase
BaseParser.getObjectFromPool
(COSObjectKey key) private COSBase
BaseParser.parseCOSDictionaryValue()
This will parse a PDF dictionary value.protected COSBase
BaseParser.parseDirObject()
This will parse a directory object from the stream.private COSBase
PDFObjectStreamParser.parseObject
(int offset) 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.Methods in org.apache.pdfbox.pdfparser with parameters of type COSBaseModifier and TypeMethodDescriptionprivate void
Adds newObject to toBeParsedList if it is not an COSObject or we didn't add this COSObject already (checked via addedObjects).private COSNumber
Returns length value referred to or defined in given object.Method parameters in org.apache.pdfbox.pdfparser with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate void
COSParser.addNewToList
(Queue<COSBase> toBeParsedList, Collection<COSBase> newObjects, Set<Long> addedObjects) Adds all from newObjects to toBeParsedList if it is not an COSObject or we didn't add this COSObject already (checked via addedObjects).private void
COSParser.addNewToList
(Queue<COSBase> toBeParsedList, Collection<COSBase> newObjects, Set<Long> addedObjects) Adds all from newObjects to toBeParsedList if it is not an COSObject or we didn't add this COSObject already (checked via addedObjects).private void
Adds newObject to toBeParsedList if it is not an COSObject or we didn't add this COSObject already (checked via addedObjects). -
Uses of COSBase in org.apache.pdfbox.pdfwriter
Fields in org.apache.pdfbox.pdfwriter declared as COSBaseFields in org.apache.pdfbox.pdfwriter with type parameters of type COSBaseModifier and TypeFieldDescriptionCOSWriter.actualsAdded
private final Map<COSObjectKey,
COSBase> COSWriter.keyObject
private final Map<COSBase,
COSObjectKey> COSWriter.objectKeys
COSWriter.objectsToWrite
COSWriter.objectsToWriteSet
COSWriter.writtenObjects
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 TypeMethodDescriptionprivate void
COSWriter.addObjectToWrite
(COSBase object) void
COSWriter.doWriteObject
(COSBase obj) This will write a COS object.private COSObjectKey
COSWriter.getObjectKey
(COSBase obj) This will get the object key for the object.private boolean
COSWriter.isNeedToBeUpdated
(COSBase base) Convenience method, so that we get false for types that can't be updated.private void
This will set the object for this xref.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 TypeMethodDescriptionprivate COSBase
Returns the resource with the given name and kind, or null.static 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 that return types with arguments of type COSBaseMethods 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.private
PDStream
(PDDocument doc, InputStream input, COSBase filters) 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.private COSBase
PDComplexFileSpecification.getObjectFromEFDictionary
(COSName key) 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.private boolean
PDAttributeObject.isValueChanged
(COSBase oldValue, COSBase newValue) Is the value changed?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
Fields in org.apache.pdfbox.pdmodel.encryption with type parameters of type COSBaseMethods 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 COSBaseMethod parameters in org.apache.pdfbox.pdmodel.font with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate float
PDType3CharProc.parseWidth
(Operator operator, List<COSBase> arguments) -
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 COSBaseModifier and TypeMethodDescriptionPDInlineImage.getCOSObject()
private COSBase
PDInlineImage.toLongName
(COSBase cs) Methods in org.apache.pdfbox.pdmodel.graphics.image with parameters of type COSBaseModifier and TypeMethodDescriptionprivate PDColorSpace
PDInlineImage.createColorSpace
(COSBase cs) private COSBase
PDInlineImage.toLongName
(COSBase cs) Constructors 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.optionalcontent
Methods in org.apache.pdfbox.pdmodel.graphics.optionalcontent with parameters of type COSBaseModifier and TypeMethodDescriptionprivate COSDictionary
PDOptionalContentProperties.toDictionary
(COSBase o) -
Uses of COSBase in org.apache.pdfbox.pdmodel.graphics.state
Fields in org.apache.pdfbox.pdmodel.graphics.state declared as COSBaseMethods 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
Fields in org.apache.pdfbox.pdmodel.interactive.annotation declared as COSBaseMethods 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
Fields in org.apache.pdfbox.pdmodel.interactive.form declared as COSBaseMethods 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 TypeMethodDescriptionFieldUtils.getPairableItems
(COSBase items, int pairIdx) Return either one of a list which can have two-element arrays entries.protected 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.Method parameters in org.apache.pdfbox.pdmodel.interactive.form with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate void
PDDefaultAppearanceString.processOperator
(Operator operator, List<COSBase> operands) This is used to handle an operation.private void
PDDefaultAppearanceString.processSetFont
(List<COSBase> operands) Process the set font and font size operator.private void
PDDefaultAppearanceString.processSetFontColor
(List<COSBase> operands) Process the font color operator.Constructors in org.apache.pdfbox.pdmodel.interactive.form with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.preflight
Fields in org.apache.pdfbox.preflight with type parameters of type COSBaseModifier and TypeFieldDescriptionprivate final Map<COSBase,
FontContainer<?>> PreflightContext.fontContainers
Contains the list of font name embedded in the PDF document.Methods in org.apache.pdfbox.preflight with parameters of type COSBaseModifier and TypeMethodDescriptionvoid
PreflightContext.addFontContainer
(COSBase cBase, FontContainer<?> fc) Add a FontContainer to allow TextObject validation.PreflightContext.getFontContainer
(COSBase cBase) Return the FontContainer identified by the COSBase. -
Uses of COSBase in org.apache.pdfbox.preflight.action
Methods in org.apache.pdfbox.preflight.action with parameters of type COSBaseModifier and TypeMethodDescriptionprivate void
ActionManagerFactory.callCreateAction
(COSBase aDict, PreflightContext ctx, List<AbstractActionManager> result, String additionActionKey, Map<COSObjectKey, Boolean> alreadyCreated) Call the create action to add the ActionManager to the result list.private void
ActionManagerFactory.callCreateAction
(COSBase aDict, PreflightContext ctx, List<AbstractActionManager> result, Map<COSObjectKey, Boolean> alreadyCreated) Call the callCreateAction(COSBase, COSDocument, List, String) method with null as isAA parameter. -
Uses of COSBase in org.apache.pdfbox.preflight.annotation
Methods in org.apache.pdfbox.preflight.annotation that return COSBase -
Uses of COSBase in org.apache.pdfbox.preflight.content
Methods in org.apache.pdfbox.preflight.content that return COSBaseMethods in org.apache.pdfbox.preflight.content with parameters of type COSBaseMethod parameters in org.apache.pdfbox.preflight.content with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate void
StubOperator.checkArrayOperands
(List<COSBase> arguments, int length) If the arguments list of Operator doesn't have Array parameter, this method throws a ContentStreamException.private void
StubOperator.checkNoOperands
(List<COSBase> arguments) If the arguments list of Operator isn't empty, this method throws a ContentStreamException.private void
StubOperator.checkNumberOperands
(List<COSBase> arguments, int length) If the arguments list of Operator doesn't have Number parameters (Int, float...), this method throws a ContentStreamException.protected void
PreflightStreamEngine.checkSetColorSpaceOperators
(Operator operator, List<COSBase> arguments) This method validates if the ColorSpace used as operand is consistent with the color space defined in OutputIntent dictionaries.private void
StubOperator.checkStringOperands
(List<COSBase> arguments, int length) If the arguments list of Operator doesn't have String parameter, this method throws a ContentStreamException.private void
StubOperator.checkTagAndPropertyOperands
(List<COSBase> arguments) The given arguments list is valid only if the first argument is a Tag (A String) and if the second argument is a String or a Dictionaryvoid
protected void
PreflightContentStream.processOperator
(Operator operator, List<COSBase> operands) protected void
PreflightContentStream.unsupportedOperator
(Operator operator, List<COSBase> arguments) protected void
PreflightStreamEngine.validateRenderingIntent
(Operator operator, List<COSBase> arguments) Check operands of the "ri" operator. -
Uses of COSBase in org.apache.pdfbox.preflight.font
Methods in org.apache.pdfbox.preflight.font with parameters of type COSBaseModifier and TypeMethodDescriptionprotected void
DescendantFontValidator.checkCIDSystemInfo
(COSBase sysinfo) Check the content of the CIDSystemInfo dictionary.protected boolean
Type0FontValidator.checkCIDSystemInfo
(COSBase sysinfo) Check the content of the CIDSystemInfo dictionary.protected void
CIDType0FontValidator.checkCIDToGIDMap
(COSBase ctog) protected void
CIDType2FontValidator.checkCIDToGIDMap
(COSBase ctog) protected abstract void
DescendantFontValidator.checkCIDToGIDMap
(COSBase ctog) This method checks the CIDtoGIDMap entry of the Font dictionary.protected void
DescendantFontValidator.checkCIDToGIDMap
(COSBase ctog, boolean mandatory) This method checks the CIDtoGIDMap entry of the Font dictionary.protected void
Type0FontValidator.checkCMapEncoding
(COSBase encoding) -
Uses of COSBase in org.apache.pdfbox.preflight.font.util
Method parameters in org.apache.pdfbox.preflight.font.util with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate void
PreflightType3Stream.checkType3FirstOperator
(List<COSBase> arguments) According to the PDF Reference, the first operator in a CharProc of a Type3 font must be "d0" or "d1".protected void
PreflightType3Stream.processOperator
(Operator operator, List<COSBase> operands) This is used to handle an operation. -
Uses of COSBase in org.apache.pdfbox.preflight.metadata
Methods in org.apache.pdfbox.preflight.metadata with parameters of type COSBaseModifier and TypeMethodDescriptionprivate boolean
SynchronizedMetaDataValidation.isValidPDFDateFormat
(COSBase item) Verifies that a date item is a COSString and has the format "D:YYYYMMDDHHmmSSOHH'mm'", where D:YYYY is mandatory and the next fields optional, but only if all of their preceding fields are also present. -
Uses of COSBase in org.apache.pdfbox.preflight.parser
Methods in org.apache.pdfbox.preflight.parser that return COSBaseModifier and TypeMethodDescriptionprotected COSBase
PreflightParser.parseDirObject()
CallBaseParser.parseDirObject()
check limit range for Float, Integer and number of Dictionary entries.protected COSBase
PreflightParser.parseObjectDynamically
(long objNr, int objGenNr, boolean requireExistingNotCompressedObj) -
Uses of COSBase in org.apache.pdfbox.preflight.process
Methods in org.apache.pdfbox.preflight.process with parameters of type COSBaseModifier and TypeMethodDescriptionprivate COSObject
BookmarkValidationProcess.toCOSObject
(COSBase base) Returns a COSBase as a COSObject or null if null or COSNull.protected void
CatalogValidationProcess.validateICCProfile
(COSBase destOutputProfile, Map<COSObjectKey, Boolean> mapDestOutputProfile, PreflightContext ctx) This method checks the destOutputProfile which must be a valid ICCProfile. -
Uses of COSBase in org.apache.pdfbox.preflight.utils
Methods in org.apache.pdfbox.preflight.utils that return COSBaseModifier and TypeMethodDescriptionprivate static COSBase
COSUtils.getCOSObjectAsClass
(COSObject cosObject, COSDocument cDoc, Class claz) Return the COSObject object as class if the COSObject object is a reference to an object of that class.Methods in org.apache.pdfbox.preflight.utils with parameters of type COSBaseModifier 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.static COSDictionary
COSUtils.getAsDictionary
(COSBase cbase, COSDocument cDoc) Return the COSBase object as COSDictionary if the COSBase object is an instance of COSDictionary or a reference to a COSDictionary object.static Float
COSUtils.getAsFloat
(COSBase cbase, COSDocument cDoc) Return the COSBase object as Float if the COSBase object is an instance of COSFloat or a reference to a COSFloat object.static Integer
COSUtils.getAsInteger
(COSBase cbase, COSDocument cDoc) Return the COSBase object as Integer if the COSBase object is an instance of COSInteger or a reference to a COSInteger object.static COSStream
COSUtils.getAsStream
(COSBase cbase, COSDocument cDoc) Return the COSBase object as COSStream if the COSBase object is an instance of COSStream or a reference to a COSStream object.static String
COSUtils.getAsString
(COSBase cbase, COSDocument cDoc) Return the COSBase object as String if the COSBase object is an instance of COSString or COSName or a reference to it.static boolean
COSUtils.isArray
(COSBase elt, COSDocument doc) return true if the elt is a COSArray or a reference to a COSArrayprivate static boolean
COSUtils.isClass
(COSBase elt, COSDocument doc, Class claz) return true if the elt is of class or a reference to a that class.static boolean
COSUtils.isDictionary
(COSBase elt, COSDocument doc) return true if the elt is a COSDictionary or a reference to a COSDictionarystatic boolean
COSUtils.isFloat
(COSBase elt, COSDocument doc) return true if the elt is a COSFloat or a reference to a COSFloatstatic boolean
COSUtils.isInteger
(COSBase elt, COSDocument doc) return true if the elt is a COSInteger or a reference to a COSIntegerstatic boolean
COSUtils.isNumeric
(COSBase elt, COSDocument doc) return true if elt is COSInteger or COSFloatstatic boolean
COSUtils.isStream
(COSBase elt, COSDocument doc) return true if the elt is a COSStream or a reference to a COSStreamstatic boolean
COSUtils.isString
(COSBase elt, COSDocument doc) return true if the elt is a COSString or a COSName or a reference to it. -
Uses of COSBase in org.apache.pdfbox.rendering
Methods in org.apache.pdfbox.rendering with parameters of type COSBaseModifier and TypeMethodDescriptionprivate BufferedImage
PageDrawer.applyTransferFunction
(BufferedImage image, COSBase transfer) Method parameters in org.apache.pdfbox.rendering with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate boolean
PageDrawer.hasBlendMode
(PDTransparencyGroup group, Set<COSBase> groupsDone) -
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.