Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES    

Uses of Class
org.pdfbox.cos.COSBase

Packages that use COSBase
org.pdfbox.cos These are the low level objects that make up a PDF document.  
org.pdfbox.encoding This package contains the implementations for all of the encodings that are used in PDF documents. 
org.pdfbox.io This package contains IO streams. 
org.pdfbox.pdfparser The pdfparser package contains classes to parse PDF documents and objects within the document. 
org.pdfbox.pdfwriter This is the persistence layer used to write the PDFBox documents to a stream. 
org.pdfbox.pdmodel The PDModel package represents a high level API for creating and manipulating PDF documents. 
org.pdfbox.pdmodel.common High level PD classes that are used throughout several packages are placed in the PDModel common package. 
org.pdfbox.pdmodel.common.filespecification The file specification package defines classes that are used for the PDF File Specification logic. 
org.pdfbox.pdmodel.common.function This package contains functions that are available in the PDF specification. 
org.pdfbox.pdmodel.documentinterchange.logicalstructure The logical structure package provides a mechanism for incorporating structural information about a document's content into a PDF file. 
org.pdfbox.pdmodel.documentinterchange.prepress This package contains classes for prepress support in PDFBox. 
org.pdfbox.pdmodel.fdf The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document. 
org.pdfbox.pdmodel.font Classes to deal with font functionality in a PDF Document. 
org.pdfbox.pdmodel.graphics The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document. 
org.pdfbox.pdmodel.graphics.color This package deals with colors that are stored in a PDF document. 
org.pdfbox.pdmodel.graphics.xobject This package deals with images that are stored in a PDF document. 
org.pdfbox.pdmodel.interactive.action This package represents actions that can be performed in a PDF document. 
org.pdfbox.pdmodel.interactive.action.type This package contains all of the available PDF action types. 
org.pdfbox.pdmodel.interactive.annotation The annotation package contains classes that work with PDF annotation elements. 
org.pdfbox.pdmodel.interactive.digitalsignature The digitial signature library will manage signatures that are stored in the PDF document. 
org.pdfbox.pdmodel.interactive.documentnavigation.destination The destination package allows destinations into a pdf document to be specified. 
org.pdfbox.pdmodel.interactive.documentnavigation.outline The outline package allows for a PDF outline(bookmarks) to be created. 
org.pdfbox.pdmodel.interactive.form The interactive package contains classes that deal with interactive annotations such as textfields and buttons. 
org.pdfbox.pdmodel.interactive.pagenavigation A package to allow provide access to PDF page navigation functionality. 
org.pdfbox.pdmodel.interactive.viewerpreferences A package to allow access to document viewing preferences. 
 

Uses of COSBase in org.pdfbox.cos
 

Subclasses of COSBase in org.pdfbox.cos
 class COSArray
          An array of PDFBase objects as part of the PDF document.
 class COSBoolean
          This class represents a boolean value in the PDF document.
 class COSDictionary
          This class represents a dictionary where name/value pairs reside.
 class COSDocument
          This is the in-memory representation of the PDF document.
 class COSFloat
          This class represents a floating point number in a PDF document.
 class COSInteger
          This class represents an integer number in a PDF document.
 class COSName
          This class represents a PDF named object.
 class COSNull
          This class represents a null PDF object.
 class COSNumber
          This class represents an abstract number in a PDF document.
 class COSObject
          This class represents a PDF object.
 class COSStream
          This class represents a stream object in a PDF document.
 class COSString
          This represents a string object in a PDF document.
 

Methods in org.pdfbox.cos that return COSBase
 COSBase COSStream.getFilters()
          This will return the filters to apply to the byte stream.
 COSBase 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.
 COSBase COSObject.getItem(COSName key)
          This will get the dictionary object in this object that has the name key.
 COSBase COSObject.getObject()
          This will get the object that this object encapsulates.
 COSBase COSDictionary.getDictionaryObject(String key)
          This will get an object from this dictionary.
 COSBase COSDictionary.getDictionaryObject(String firstKey, String 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.
 COSBase COSDictionary.getDictionaryObject(String[] keyList)
          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.
 COSBase COSDictionary.getDictionaryObject(COSName key)
          This will get an object from this dictionary.
 COSBase COSDictionary.getItem(COSName key)
          This will do a lookup into the dictionary.
 COSBase COSDictionary.getObjectFromPath(String objPath)
          Nice method, gives you every object you want Arrays works properly too.
 COSBase COSBase.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase COSArray.getObject(int index)
          This will get an object from the array.
 COSBase COSArray.get(int index)
          This will get an object from the array.
 COSBase COSArray.remove(int i)
          This will remove an element from the array.
 

Methods in org.pdfbox.cos with parameters of type COSBase
 OutputStream COSStream.createFilteredStream(COSBase expectedLength)
          This will create a new stream for which filtered byte should be written to.
 void COSStream.setFilters(COSBase filters)
          set the filters to be applied to the stream.
 void COSObject.setObject(COSBase object)
          This will set the object that this object encapsulates.
 void COSDictionary.setItem(COSName key, COSBase value)
          This will set an item in the dictionary.
 void COSDictionary.setItem(String key, COSBase value)
          This will set an item in the dictionary.
 void COSArray.add(COSBase object)
          This will add an object to the array.
 void COSArray.add(int i, COSBase object)
          Add the specified object at the ith location and push the rest to the right.
 void COSArray.set(int index, COSBase object)
          This will set an object at a specific index.
 boolean COSArray.remove(COSBase o)
          This will remove an element from the array.
 int COSArray.indexOf(COSBase object)
          This will return the index of the entry or -1 if it is not found.
 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.
 

Constructors in org.pdfbox.cos with parameters of type COSBase
COSObject(COSBase object)
          Constructor.
 

Uses of COSBase in org.pdfbox.encoding
 

Methods in org.pdfbox.encoding that return COSBase
 COSBase WinAnsiEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase StandardEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PdfDocEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase MacRomanEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase DictionaryEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase AFMEncoding.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.io
 

Methods in org.pdfbox.io that return COSBase
 COSBase RandomAccessFileOutputStream.getExpectedLength()
          This will get the length that the PDF document specified this stream should be.
 

Methods in org.pdfbox.io with parameters of type COSBase
 void RandomAccessFileOutputStream.setExpectedLength(COSBase value)
          This will set the expected length of this stream.
 

Uses of COSBase in org.pdfbox.pdfparser
 

Methods in org.pdfbox.pdfparser that return COSBase
protected  COSBase BaseParser.parseDirObject()
          This will parse a directory object from the stream.
 

Uses of COSBase in org.pdfbox.pdfwriter
 

Methods in org.pdfbox.pdfwriter that return COSBase
 COSBase COSWriterXRefEntry.getObject()
          This will get the object.
 

Methods in org.pdfbox.pdfwriter with parameters of type COSBase
 void COSWriter.doWriteObject(COSBase obj)
          This will write a COS object.
 void COSWriter.writeReference(COSBase obj)
          visitFromObjRef method comment.
 

Constructors in org.pdfbox.pdfwriter with parameters of type COSBase
COSWriterXRefEntry(long start, COSBase obj, COSObjectKey keyValue)
          COSWriterXRefEntry constructor comment.
 

Uses of COSBase in org.pdfbox.pdmodel
 

Methods in org.pdfbox.pdmodel that return COSBase
 COSBase PDResources.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDPageNode.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDPage.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDocumentNameDictionary.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDocumentInformation.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDocumentCatalog.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel with parameters of type COSBase
protected  Object PDEmbeddedFilesNameTreeNode.convertCOSToPD(COSBase base)
          Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply use reflection to create the correct object type. Subclasses can do whatever they want.
protected  Object PDDestinationNameTreeNode.convertCOSToPD(COSBase base)
          Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply use reflection to create the correct object type. Subclasses can do whatever they want.
 

Uses of COSBase in org.pdfbox.pdmodel.common
 

Subclasses of COSBase in org.pdfbox.pdmodel.common
 class COSStreamArray
          This will take an array of streams and sequence them together.
 

Methods in org.pdfbox.pdmodel.common that return COSBase
 COSBase PDTextStream.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDStream.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDRectangle.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDRange.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDNameTreeNode.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDNamedTextStream.getFirstCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDNamedTextStream.getSecondCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDMemoryStream.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDMatrix.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase DualCOSObjectable.getFirstCOSObject()
          Convert this standard java object to a COS object.
 COSBase DualCOSObjectable.getSecondCOSObject()
          Convert this standard java object to a COS object.
 COSBase COSStreamArray.getItem(COSName key)
          This will get an object from this streams dictionary.
 COSBase COSStreamArray.getDictionaryObject(COSName key)
          This will get an object from this streams dictionary and dereference it if necessary.
 COSBase COSStreamArray.getFilters()
          This will return the filters to apply to the byte stream the method will return
 COSBase COSObjectable.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.common with parameters of type COSBase
static PDTextStream PDTextStream.createTextStream(COSBase base)
          This will create the text stream object.
static PDStream PDStream.createFromCOS(COSBase base)
          Create a pd stream from either a regular COSStream on a COSArray of cos streams.
protected  Object PDNameTreeNode.convertCOSToPD(COSBase base)
          Method to convert the COS value in the name tree to the PD Model object.
 OutputStream COSStreamArray.createFilteredStream(COSBase expectedLength)
          This will create a new stream for which filtered byte should be written to.
 void COSStreamArray.setFilters(COSBase filters)
          set the filters to be applied to the stream.
 

Constructors in org.pdfbox.pdmodel.common with parameters of type COSBase
PDNamedTextStream(COSName name, COSBase str)
          Constructor.
COSArrayList(Object actualObject, COSBase item, COSDictionary dictionary, String dictionaryKey)
          This is a really special constructor.
 

Uses of COSBase in org.pdfbox.pdmodel.common.filespecification
 

Methods in org.pdfbox.pdmodel.common.filespecification that return COSBase
 COSBase PDSimpleFileSpecification.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDComplexFileSpecification.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.common.filespecification with parameters of type COSBase
static PDFileSpecification PDFileSpecification.createFS(COSBase base)
          A file specfication can either be a COSString or a COSDictionary.
 

Uses of COSBase in org.pdfbox.pdmodel.common.function
 

Methods in org.pdfbox.pdmodel.common.function that return COSBase
 COSBase PDStreamFunction.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDictionaryFunction.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.common.function with parameters of type COSBase
static PDFunction PDFunction.create(COSBase function)
          Create the correct PD Model function based on the COS base function.
 

Uses of COSBase in org.pdfbox.pdmodel.documentinterchange.logicalstructure
 

Methods in org.pdfbox.pdmodel.documentinterchange.logicalstructure that return COSBase
 COSBase PDStructureTreeRoot.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDStructureElement.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDMarkInfo.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.documentinterchange.prepress
 

Methods in org.pdfbox.pdmodel.documentinterchange.prepress that return COSBase
 COSBase PDBoxStyle.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.fdf
 

Methods in org.pdfbox.pdmodel.fdf that return COSBase
 COSBase FDFTemplate.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFPageInfo.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFPage.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFOptionElement.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFNamedPageReference.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFJavaScript.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFIconFit.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFField.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFDictionary.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFCatalog.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase FDFAnnotation.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.font
 

Methods in org.pdfbox.pdmodel.font that return COSBase
 COSBase PDFontDescriptorDictionary.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDFont.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.graphics
 

Methods in org.pdfbox.pdmodel.graphics that return COSBase
 COSBase PDLineDashPattern.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDFontSetting.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDExtendedGraphicsState.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.graphics.color
 

Methods in org.pdfbox.pdmodel.graphics.color that return COSBase
 COSBase PDTristimulus.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDLab.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDICCBased.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDGamma.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDeviceN.getTintTransform()
          This will get the tint transform function.
 COSBase PDColorSpace.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDCalRGB.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDCalGray.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.graphics.color with parameters of type COSBase
 void PDDeviceN.setTintTransform(COSBase tint)
          This will set the tint transform function.
static PDColorSpace PDColorSpaceFactory.createColorSpace(COSBase colorSpace)
          This will create the correct color space given the name.
 

Uses of COSBase in org.pdfbox.pdmodel.graphics.xobject
 

Methods in org.pdfbox.pdmodel.graphics.xobject that return COSBase
 COSBase PDXObject.getCOSObject()
          Returns the stream.
 

Methods in org.pdfbox.pdmodel.graphics.xobject with parameters of type COSBase
static PDXObject PDXObject.createXObject(COSBase xobject)
          Create the correct xobject from the cos base.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.action
 

Methods in org.pdfbox.pdmodel.interactive.action that return COSBase
 COSBase PDPageAdditionalActions.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDFormFieldAdditionalActions.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDDocumentCatalogAdditionalActions.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDAnnotationAdditionalActions.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDAdditionalActions.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.action.type
 

Methods in org.pdfbox.pdmodel.interactive.action.type that return COSBase
 COSBase PDWindowsLaunchParams.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDActionURI.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDActionRemoteGoTo.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDActionRemoteGoTo.getD()
          This will get the destination to jump to.
 COSBase PDAction.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.interactive.action.type with parameters of type COSBase
 void PDActionRemoteGoTo.setD(COSBase d)
          This will set the destination to jump to.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.annotation
 

Methods in org.pdfbox.pdmodel.interactive.annotation that return COSBase
 COSBase PDBorderStyleDictionary.getCOSObject()
          returns the dictionary.
 COSBase PDBorderEffectDictionary.getCOSObject()
          returns the dictionary.
 COSBase PDAppearanceStream.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDAppearanceDictionary.getCOSObject()
          returns the dictionary.
 COSBase PDAnnotation.getCOSObject()
          Interface method for COSObjectable.
 

Methods in org.pdfbox.pdmodel.interactive.annotation with parameters of type COSBase
static PDAnnotation PDAnnotation.createAnnotation(COSBase base)
          Create the correct annotation from the base COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.digitalsignature
 

Methods in org.pdfbox.pdmodel.interactive.digitalsignature that return COSBase
 COSBase PDSignature.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.documentnavigation.destination
 

Methods in org.pdfbox.pdmodel.interactive.documentnavigation.destination that return COSBase
 COSBase PDPageDestination.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDNamedDestination.getCOSObject()
          Convert this standard java object to a COS object.
 

Methods in org.pdfbox.pdmodel.interactive.documentnavigation.destination with parameters of type COSBase
static PDDestination PDDestination.create(COSBase base)
          This will create a new destination depending on the type of COSBase that is passed in.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.documentnavigation.outline
 

Methods in org.pdfbox.pdmodel.interactive.documentnavigation.outline that return COSBase
 COSBase PDOutlineNode.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.form
 

Methods in org.pdfbox.pdmodel.interactive.form that return COSBase
 COSBase PDXFA.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDField.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDAcroForm.getCOSObject()
          Convert this standard java object to a COS object.
 

Constructors in org.pdfbox.pdmodel.interactive.form with parameters of type COSBase
PDXFA(COSBase xfaBase)
          Constructor.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.pagenavigation
 

Methods in org.pdfbox.pdmodel.interactive.pagenavigation that return COSBase
 COSBase PDThreadBead.getCOSObject()
          Convert this standard java object to a COS object.
 COSBase PDThread.getCOSObject()
          Convert this standard java object to a COS object.
 

Uses of COSBase in org.pdfbox.pdmodel.interactive.viewerpreferences
 

Methods in org.pdfbox.pdmodel.interactive.viewerpreferences that return COSBase
 COSBase PDViewerPreferences.getCOSObject()
          Convert this standard java object to a COS object.
 

Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
 PREV   NEXT FRAMES    NO FRAMES