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 packages in this package will show how to use the PDFBox util API.
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 voidPDFStreamEngine.operatorException(Operator operator, List<COSBase> operands, IOException exception) Called when an exception is thrown by an operator.voidPDFStreamEngine.processOperator(String operation, List<COSBase> arguments) This is used to handle an operation.protected voidPDFStreamEngine.processOperator(Operator operator, List<COSBase> operands) This is used to handle an operation.protected voidPDFStreamEngine.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 TypeMethodDescriptionbooleanOperatorProcessor.checkArrayTypesClass(List<COSBase> operands, Class<?> clazz) Check whether all operands list elements are an instance of a specific class.voidabstract voidProcess 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 TypeMethodDescriptionvoidvoidvoidvoidvoidvoidvoidvoidvoidRG 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 TypeMethodDescriptionvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidfinal voidvoidvoidvoidvoid -
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 TypeMethodDescriptionvoidvoidvoidvoid -
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 TypeMethodDescriptionvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoid -
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 TypeMethodDescriptionvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoidvoid -
Uses of COSBase in org.apache.pdfbox.cos
Subclasses of COSBase in org.apache.pdfbox.cosModifier and TypeClassDescriptionclassAn array of PDFBase objects as part of the PDF document.final classThis class represents a boolean value in the PDF document.classThis class represents a dictionary where name/value pairs reside.classThis is the in-memory representation of the PDF document.classThis class represents a floating point number in a PDF document.final classThis class represents an integer number in a PDF document.final classA PDF Name object.final classThis class represents a null PDF object.classThis class represents an abstract number in a PDF document.classThis class represents a PDF object.classThis class represents a stream object in a PDF document.final classA string object, which may be a text string, a PDFDocEncoded string, ASCII string, or byte string.(package private) final classAn unmodifiable COSDictionary.Fields in org.apache.pdfbox.cos declared as COSBaseFields in org.apache.pdfbox.cos with type parameters of type COSBaseModifier and TypeFieldDescriptionCOSIncrement.excludedContains the directCOSBases, that are either contained written directly by structures contained inCOSIncrement.objectsor that must be excluded from being written as indirectCOSObjects for other reasons.COSDictionary.itemsThe name-value pairs of this dictionary.COSArray.objectsCOSIncrement.objectsContains theCOSBases, that shall be added to the increment at top level.Methods in org.apache.pdfbox.cos that return COSBaseModifier and TypeMethodDescriptionICOSParser.dereferenceCOSObject(COSObject obj) Dereference the COSBase object which is referenced by the given COSObject.COSArray.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(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.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.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.COSIncrement.getObjects()COSDictionary.getValues()This will get all of the values for the dictionary.COSArray.iterator()Get access to the list.COSIncrement.iterator()Return an iterator for the determinedCOSIncrement.objectscontained in thisCOSIncrement.COSArray.toList()Return contents of COSArray as a Java List.Methods in org.apache.pdfbox.cos with parameters of type COSBaseModifier and TypeMethodDescriptionvoidAdd the specified object at the ith location and push the rest to the right.voidThis will add an object to the array.private voidThe given object and actual {COSBase}s shall be part of the increment and must be added toCOSIncrement.objects, if possible.
nullvalues shall be skipped.private booleanCollect all updates made to the givenCOSBaseand it's contained structures.
This shall forward allCOSUpdateInfoobjects to the proper specialized collection methods.booleanCOSStream.createOutputStream(COSBase filters) Returns a new OutputStream for writing stream data, using and the given filters.(package private) voidCOSUpdateState.dereferenceChild(COSBase child) This shallCOSUpdateState.setOriginDocumentState(COSDocumentState, boolean)for the dereferenced child, initializing itsCOSUpdateState.originDocumentState.The givenCOSBases are not fit for inclusion in an increment and shall be added toCOSIncrement.excluded.
nullvalues shall be ignored.private static StringCOSDictionary.getDictionaryString(COSBase base, List<COSBase> objs) voidCOSArray.growToSize(int size, COSBase object) This will add the object until the size of the array is at least as large as the parameter.intThis will return the index of the entry or -1 if it is not found.intCOSArray.indexOfObject(COSBase object) This will return the index of the entry or -1 if it is not found.private booleanCOSIncrement.isExcluded(COSBase base) Returnstrue, if the givenCOSBasehas been excluded from the increment, and hence is contained inCOSIncrement.excluded.booleanThis will remove an element from the array.booleanCOSArray.removeObject(COSBase o) This will remove an element from the array.voidThis will set an object at a specific index.voidThis will set an item in the dictionary.voidThis will set an item in the dictionary.(package private) voidShall callCOSUpdateState.update()for thisCOSUpdateStateand shallCOSUpdateState.setOriginDocumentState(COSDocumentState)for the given child, initializing it´sCOSUpdateState.updatedstate andCOSUpdateState.originDocumentState.Method parameters in org.apache.pdfbox.cos with type arguments of type COSBaseModifier and TypeMethodDescriptionvoidCOSArray.addAll(int i, Collection<COSBase> objectList) Add the specified object at the ith location and push the rest to the right.voidCOSArray.addAll(Collection<COSBase> objectsList) This will add an object to the array.voidCOSDictionary.forEach(BiConsumer<? super COSName, ? super COSBase> action) Convenience method that callsMap.forEach(BiConsumer).private static StringCOSDictionary.getDictionaryString(COSBase base, List<COSBase> objs) voidCOSArray.removeAll(Collection<COSBase> objectsList) This will remove all of the objects in the collection.voidCOSArray.retainAll(Collection<COSBase> objectsList) This will retain all of the objects in the collection.(package private) voidShall callCOSUpdateState.update()for thisCOSUpdateStateand shallCOSUpdateState.setOriginDocumentState(COSDocumentState)for the given children, initializing theirCOSUpdateState.updatedstate andCOSUpdateState.originDocumentState.Constructors in org.apache.pdfbox.cos with parameters of type COSBaseModifierConstructorDescriptionConstructor.COSObject(COSBase object, COSObjectKey objectKey) Constructor.COSObject(COSBase object, ICOSParser parser) Constructor. -
Uses of COSBase in org.apache.pdfbox.debugger
Methods in org.apache.pdfbox.debugger that return COSBaseModifier and TypeMethodDescriptionprivate COSBasePDFDebugger.getUnderneathObject(Object selectedNode) -
Uses of COSBase in org.apache.pdfbox.debugger.ui
Fields in org.apache.pdfbox.debugger.ui declared as COSBaseModifier and TypeFieldDescriptionprivate COSBaseArrayEntry.itemprivate COSBaseMapEntry.itemprivate COSBaseArrayEntry.valueprivate COSBaseMapEntry.valueMethods 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.XrefEntry.getObject()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 TypeMethodDescriptionvoidThis will set the value for this entry.voidThis will set the value for this entry.voidThis will set the value for this entry.voidThis will set the value for this entry. -
Uses of COSBase in org.apache.pdfbox.examples.printing
Method parameters in org.apache.pdfbox.examples.printing with type arguments of type COSBase -
Uses of COSBase in org.apache.pdfbox.examples.signature.validation
Methods in org.apache.pdfbox.examples.signature.validation with type parameters of type COSBaseModifier and TypeMethodDescriptionprivate static <T extends COSBase & COSUpdateInfo>
TAddValidationInformation.getOrCreateDictionaryEntry(Class<T> clazz, COSDictionary parent, String name) Gets or creates a dictionary entry. -
Uses of COSBase in org.apache.pdfbox.examples.util
Method parameters in org.apache.pdfbox.examples.util with type arguments of type COSBaseModifier and TypeMethodDescriptionprotected voidPrintImageLocations.processOperator(Operator operator, List<COSBase> operands) This is used to handle an operation. -
Uses of COSBase in org.apache.pdfbox.multipdf
Fields in org.apache.pdfbox.multipdf with type parameters of type COSBaseModifier and TypeFieldDescriptionPDFCloneUtility.clonedValuesPDFCloneUtility.clonedVersionPDFCloneUtility.clonedVersionMethods in org.apache.pdfbox.multipdf with type parameters of type COSBaseModifier and TypeMethodDescription<TCOSBase extends COSBase>
TCOSBasePDFCloneUtility.cloneForNewDocument(TCOSBase base) Deep-clones the given object for inclusion into a different PDF document identified by the destination parameter.Methods in org.apache.pdfbox.multipdf that return COSBaseModifier and TypeMethodDescriptionprivate COSBasePDFCloneUtility.cloneCOSBaseForNewDocument(COSBase base) private COSBaseSplitter.KCloner.createArrayClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) (package private) COSBaseSplitter.KCloner.createClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) Creates a clone of the source.private COSBaseSplitter.KCloner.createDictionaryClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) Methods in org.apache.pdfbox.multipdf with parameters of type COSBaseModifier and TypeMethodDescriptionprivate voidOverlay.addOriginalContent(COSBase contents, COSArray contentArray) private COSBasePDFCloneUtility.cloneCOSBaseForNewDocument(COSBase base) private voidPDFCloneUtility.cloneMergeCOSBase(COSBase source, COSBase target) private COSBaseSplitter.KCloner.createArrayClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) (package private) COSBaseSplitter.KCloner.createClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) Creates a clone of the source.private COSStreamOverlay.createCombinedContentStream(COSBase contents) Overlay.createContentStreamList(COSBase contents) private COSBaseSplitter.KCloner.createDictionaryClone(COSBase src, COSBase dstParent, COSDictionary currentPageDict) private booleanPDFCloneUtility.hasSelfReference(COSBase parent, COSBase value) Check whether an element (of an array or a dictionary) points to its parent. -
Uses of COSBase in org.apache.pdfbox.pdfparser
Fields in org.apache.pdfbox.pdfparser with type parameters of type COSBaseModifier and TypeFieldDescriptionprivate final Map<Long, Map<COSObjectKey, COSBase>> COSParser.decompressedObjectsIntermediate cache.Methods in org.apache.pdfbox.pdfparser that return COSBaseModifier and TypeMethodDescriptionCOSParser.dereferenceCOSObject(COSObject obj) private COSBaseBaseParser.getObjectFromPool(COSObjectKey key) private COSBaseBaseParser.parseCOSDictionaryValue()This will parse a PDF dictionary value.protected COSBaseBaseParser.parseDirObject()This will parse a directory object from the stream.private COSBaseCOSParser.parseFileObject(Long objOffset, COSObjectKey objKey) PDFObjectStreamParser.parseObject(long objectNumber) Search for/parse the object with the given object number.protected COSBaseCOSParser.parseObjectDynamically(COSObjectKey objKey, boolean requireExistingNotCompressedObj) Parse the object for the given object key.protected COSBaseCOSParser.parseObjectStreamObject(long objstmObjNr, COSObjectKey key) Parse the object with the given key from the object stream with the given number.Methods in org.apache.pdfbox.pdfparser that return types with arguments of type COSBaseModifier and TypeMethodDescriptionPDFObjectStreamParser.parseAllObjects()Parse all compressed objects.Methods in org.apache.pdfbox.pdfparser with parameters of type COSBase -
Uses of COSBase in org.apache.pdfbox.pdfparser.xref
Fields in org.apache.pdfbox.pdfparser.xref declared as COSBaseModifier and TypeFieldDescriptionprivate final COSBaseNormalXReference.objectprivate final COSBaseObjectStreamXReference.objectMethods in org.apache.pdfbox.pdfparser.xref that return COSBaseModifier and TypeMethodDescriptionNormalXReference.getObject()Returns theCOSObject, that is described by this crossreference stream entry.ObjectStreamXReference.getObject()Returns theCOSObject, that is described by this crossreference stream entry.Constructors in org.apache.pdfbox.pdfparser.xref with parameters of type COSBaseModifierConstructorDescriptionNormalXReference(long byteOffset, COSObjectKey key, COSBase object) Prepares a normal reference for the givenCOSObjectin a PDF's crossreference stream (PDFXRefStream).ObjectStreamXReference(int objectStreamIndex, COSObjectKey key, COSBase object, COSObjectKey parentKey) Prepares a object stream entry reference for the givenCOSObjectin a PDF's crossreference stream (PDFXRefStream). -
Uses of COSBase in org.apache.pdfbox.pdfwriter
Fields in org.apache.pdfbox.pdfwriter with type parameters of type COSBaseModifier and TypeFieldDescriptionCOSWriter.actualsAddedprivate final Map<COSObjectKey, COSBase> COSWriter.keyObjectprivate final Map<COSBase, COSObjectKey> COSWriter.objectKeysCOSWriter.objectsToWriteCOSWriter.writtenObjectsMethods in org.apache.pdfbox.pdfwriter with parameters of type COSBaseModifier and TypeMethodDescriptionprivate voidCOSWriter.addObjectToWrite(COSBase object) voidCOSWriter.doWriteObject(COSBase obj) This will write a COS object.voidCOSWriter.doWriteObject(COSObjectKey key, COSBase obj) This will write a COS object for a predefined key.private COSObjectKeyCOSWriter.getObjectKey(COSBase obj) This will get the object key for the object.private booleanCOSWriter.isNeedToBeUpdated(COSBase base) Convenience method, so that we get false for types that can't be updated.private voidContentStreamWriter.writeObject(COSBase o) voidCOSWriter.writeReference(COSBase obj) visitFromObjRef method comment.voidContentStreamWriter.writeToken(COSBase base) Writes a single operand token. -
Uses of COSBase in org.apache.pdfbox.pdfwriter.compress
Fields in org.apache.pdfbox.pdfwriter.compress with type parameters of type COSBaseModifier and TypeFieldDescriptionCOSWriterCompressionPool.allDirectObjectsprivate final Map<COSObjectKey, COSBase> COSObjectPool.keyPoolprivate final Map<COSBase, COSObjectKey> COSObjectPool.objectPoolCOSWriterObjectStream.preparedObjectsMethods in org.apache.pdfbox.pdfwriter.compress that return COSBaseModifier and TypeMethodDescriptionprivate COSBaseCOSWriterCompressionPool.addObjectToPool(COSObjectKey key, COSBase base) Adds the givenCOSBaseto this pool, using the givenCOSObjectKeyas it's referencable ID.COSObjectPool.getObject(COSObjectKey key) Returns theCOSBase, that is registered for the givenCOSObjectKey, or null if no object is registered for that key.COSWriterCompressionPool.getObject(COSObjectKey key) Returns theCOSBase, that is registered for the givenCOSObjectKeyin this compression pool.Methods in org.apache.pdfbox.pdfwriter.compress with parameters of type COSBaseModifier and TypeMethodDescriptionprivate COSBaseCOSWriterCompressionPool.addObjectToPool(COSObjectKey key, COSBase base) Adds the givenCOSBaseto this pool, using the givenCOSObjectKeyas it's referencable ID.private voidCOSWriterCompressionPool.addStructure(COSBase current) Attempts to find yet unregistered streams and dictionaries in the given structure.booleanReturns true, if the givenCOSBaseis a registered object of this pool.booleanReturns true, if the givenCOSBaseis a registered object of this compression pool.Returns theCOSObjectKeyfor a given registeredCOSBase.Returns theCOSObjectKey, that is registered for the givenCOSBasein this compression pool.voidCOSWriterObjectStream.prepareStreamObject(COSObjectKey key, COSBase object) Prepares the givenCOSObjectto be written to this object stream, using the givenCOSObjectKeyas it's ID for indirect references.COSObjectPool.put(COSObjectKey key, COSBase object) Update the key and object maps.private voidCOSWriterObjectStream.writeObject(OutputStream output, COSBase object, boolean topLevel) This method prepares and writes COS data to the object stream by selecting appropriate specialized methods for the content.Method parameters in org.apache.pdfbox.pdfwriter.compress with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate voidCOSWriterCompressionPool.addElements(Iterator<COSBase> elements) -
Uses of COSBase in org.apache.pdfbox.pdmodel
Methods in org.apache.pdfbox.pdmodel that return COSBaseModifier and TypeMethodDescriptionprivate COSBaseReturns the resource with the given name and kind, or null.static COSBasePDPageTree.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 PDPageDestinationPDDestinationNameTreeNode.convertCOSToPD(COSBase base) protected PDComplexFileSpecificationPDEmbeddedFilesNameTreeNode.convertCOSToPD(COSBase base) protected PDActionJavaScriptPDJavascriptNameTreeNode.convertCOSToPD(COSBase base) protected PDStructureElementPDStructureElementNameTreeNode.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 TPDNameTreeNode.convertCOSToPD(COSBase base) Method to convert the COS value in the name tree to the PD Model object.protected COSObjectablePDNumberTreeNode.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.privatePDStream(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 COSBasePDComplexFileSpecification.getObjectFromEFDictionary(COSName key) Methods in org.apache.pdfbox.pdmodel.common.filespecification with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDFileSpecificationA 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 PDFunctionCreate 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 COSBasePDDefaultAttributeObject.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 voidAppends a COS base kid.protected ObjectPDStructureNode.createObject(COSBase kid) Creates an object for a kid of this structure node.protected COSBasePDDefaultAttributeObject.getAttributeValue(String attrName, COSBase defaultValue) Gets the attribute value for a given name.protected voidPDStructureNode.insertBefore(COSBase newKid, Object refKid) Inserts an COS base kid before a reference kid.private booleanPDAttributeObject.isValueChanged(COSBase oldValue, COSBase newValue) Is the value changed?protected voidPDAttributeObject.potentiallyNotifyChanged(COSBase oldBase, COSBase newBase) Notifies the attribute object change listeners if the attribute is changed.protected booleanRemoves a COS base kid.voidPDDefaultAttributeObject.setAttribute(String attrName, COSBase attrValue) Sets an attribute.voidSets the K entry.voidSets 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 StringFDFAnnotation.getStringOrStream(COSBase base) Get a text or text stream.voidSets 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 floatPDType3CharProc.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 PDXObjectPDXObject.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 BlendModeBlendMode.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()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 PDColorSpaceCreates a color space given a name or array.static PDColorSpacePDColorSpace.create(COSBase colorSpace, PDResources resources) Creates a color space given a name or array.static PDColorSpacePDColorSpace.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 COSBaseMethods in org.apache.pdfbox.pdmodel.graphics.image with parameters of type COSBaseModifier and TypeMethodDescriptionprivate PDColorSpacePDInlineImage.createColorSpace(COSBase cs) private COSBasePDInlineImage.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 COSDictionaryPDOptionalContentProperties.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 PDSoftMaskCreates a new soft mask.voidPDExtendedGraphicsState.setTransfer(COSBase transfer) This will set the transfer function of the /TR dictionary.voidPDGraphicsState.setTransfer(COSBase transfer) This will set the transfer function.voidPDExtendedGraphicsState.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 with parameters of type COSBaseModifier and TypeMethodDescriptionstatic PDAnnotationPDAnnotation.createAnnotation(COSBase base) Create the correct annotation from the base COS object. -
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 COSBasePDField.getInheritableAttribute(COSName key) Returns the given attribute, inheriting from parent nodes if necessary.PDNonTerminalField.getValue()Returns the COSBase value of the "V" entry.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 StringPDVariableText.getStringOrStream(COSBase base) Get a text as text stream.voidPDNonTerminalField.setDefaultValue(COSBase value) Sets the default of this field.voidSets the value of this field.Method parameters in org.apache.pdfbox.pdmodel.interactive.form with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate voidPDDefaultAppearanceString.processOperator(Operator operator, List<COSBase> operands) This is used to handle an operation.private voidPDDefaultAppearanceString.processSetFont(List<COSBase> operands) Process the set font and font size operator.private voidPDDefaultAppearanceString.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.fontContainersContains the list of font name embedded in the PDF document.Methods in org.apache.pdfbox.preflight with parameters of type COSBaseModifier and TypeMethodDescriptionvoidPreflightContext.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 voidActionManagerFactory.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 voidActionManagerFactory.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 voidStubOperator.checkArrayOperands(List<COSBase> arguments, int length) If the arguments list of Operator doesn't have Array parameter, this method throws a ContentStreamException.private voidStubOperator.checkNoOperands(List<COSBase> arguments) If the arguments list of Operator isn't empty, this method throws a ContentStreamException.private voidStubOperator.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 voidPreflightStreamEngine.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 voidStubOperator.checkStringOperands(List<COSBase> arguments, int length) If the arguments list of Operator doesn't have String parameter, this method throws a ContentStreamException.private voidStubOperator.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 Dictionaryvoidprotected voidPreflightContentStream.processOperator(Operator operator, List<COSBase> operands) protected voidPreflightContentStream.unsupportedOperator(Operator operator, List<COSBase> arguments) protected voidPreflightStreamEngine.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 voidCIDType0FontValidator.checkCIDToGIDMap(COSBase ctog) protected voidCIDType2FontValidator.checkCIDToGIDMap(COSBase ctog) protected abstract voidDescendantFontValidator.checkCIDToGIDMap(COSBase ctog) This method checks the CIDtoGIDMap entry of the Font dictionary.protected voidDescendantFontValidator.checkCIDToGIDMap(COSBase ctog, boolean mandatory) This method checks the CIDtoGIDMap entry of the Font dictionary.protected voidType0FontValidator.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 voidPreflightType3Stream.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 voidPreflightType3Stream.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 booleanSynchronizedMetaDataValidation.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 COSBasePreflightParser.parseDirObject()CallBaseParser.parseDirObject()check limit range for Float, Integer and number of Dictionary entries.private COSBasePreflightParser.parseFileObject(Long offsetOrObjstmObNr, COSObjectKey objKey) protected COSBasePreflightParser.parseObjectDynamically(COSObjectKey objKey, 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 COSObjectBookmarkValidationProcess.toCOSObject(COSBase base) Returns a COSBase as a COSObject or null if null or COSNull.private voidCatalogValidationProcess.validateICCProfile(COSBase destOutputProfile, Map<COSObjectKey, Boolean> mapDestOutputProfile, PreflightContext ctx) This method checks the destOutputProfile which must be a valid ICCProfile.voidStreamValidationProcess.validateStreamObject(PreflightContext context, COSBase cObj) -
Uses of COSBase in org.apache.pdfbox.rendering
Fields in org.apache.pdfbox.rendering with type parameters of type COSBaseMethods in org.apache.pdfbox.rendering with parameters of type COSBaseModifier and TypeMethodDescriptionprivate BufferedImagePageDrawer.applyTransferFunction(BufferedImage image, COSBase transfer) Method parameters in org.apache.pdfbox.rendering with type arguments of type COSBaseModifier and TypeMethodDescriptionprivate booleanPageDrawer.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 MatrixMatrix.createMatrix(COSBase base) Convenience method to be used when creating a matrix from unverified data.