Uses of Interface
org.apache.pdfbox.pdmodel.common.COSObjectable
Packages that use COSObjectable
Package
Description
These are the low level objects that make up a PDF document.
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 marked content package provides a mechanism for modeling marked-content
sequences.
This package contains classes for prepress support in PDFBox.
The tagged PDF package provides a mechanism for incorporating "tags" (standard
structure types and attributes) into a PDF file.
The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
The fdf package will handle all of the logic used for FDF objects inside of the PDF/FDF document.
Classes to deal with font functionality in a PDF Document.
The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
This package deals with colors that are stored in a PDF document.
This package deals with Form XObjects that are stored in a PDF document.
This package deals with images that are stored in a PDF document.
This package deals with patterns which are used instead of colors.
This package deals with shadings which are used for filling instead of a color.
This package deals with graphics states within the PDF document.
This package represents actions that can be performed in a PDF document.
The annotation package contains classes that work with PDF annotation elements.
The digital signature library will manage signatures that are stored in the PDF document.
The destination package allows destinations into a pdf document to be specified.
The outline package allows for a PDF outline(bookmarks) to be created.
The interactive package contains classes for handling Interactive Forms, also known as "AcroForms".
The measurement package contains classes that work with elements specifying measure properties.
A package to allow provide access to PDF page navigation functionality.
A package to allow access to document viewing preferences.
-
Uses of COSObjectable in org.apache.pdfbox.cos
Classes in org.apache.pdfbox.cos that implement COSObjectableModifier and TypeClassDescriptionclass
An array of PDFBase objects as part of the PDF document.class
The base object that all objects in the PDF document will extend.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.Methods in org.apache.pdfbox.cos with parameters of type COSObjectableModifier and TypeMethodDescriptionvoid
COSArray.add
(COSObjectable object) This will add an object to the array.void
COSArray.set
(int index, COSObjectable object) This will set an object at a specific index.void
COSDictionary.setItem
(String key, COSObjectable value) This will set an item in the dictionary.void
COSDictionary.setItem
(COSName key, COSObjectable value) This will set an item in the dictionary.void
UnmodifiableCOSDictionary.setItem
(String key, COSObjectable value) This will set an item in the dictionary.void
UnmodifiableCOSDictionary.setItem
(COSName key, COSObjectable value) This will set an item in the dictionary. -
Uses of COSObjectable in org.apache.pdfbox.multipdf
Methods in org.apache.pdfbox.multipdf that return types with arguments of type COSObjectableModifier and TypeMethodDescription(package private) static Map<Integer,
COSObjectable> PDFMergerUtility.getNumberTreeAsMap
(PDNumberTreeNode tree) Methods in org.apache.pdfbox.multipdf with parameters of type COSObjectableModifier and TypeMethodDescriptionvoid
PDFCloneUtility.cloneMerge
(COSObjectable base, COSObjectable target) Merges two objects of the same type by deep-cloning its members.Method parameters in org.apache.pdfbox.multipdf with type arguments of type COSObjectableModifier and TypeMethodDescriptionprivate void
PDFMergerUtility.updatePageReferences
(PDFCloneUtility cloner, Map<Integer, COSObjectable> numberTreeAsMap, Map<COSDictionary, COSDictionary> objMapping) Update the Pg and Obj references to the new (merged) page. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel
Classes in org.apache.pdfbox.pdmodel that implement COSObjectableModifier and TypeClassDescriptionclass
This class holds all of the name trees that are available at the document level.class
The Document Catalog of a PDF.class
This is the document metadata.class
This encapsulates the "dictionary of names and corresponding destinations" for the /Dests entry in the document catalog.class
This class holds all of the name trees that are available at the document level.class
This class holds all of the name trees that are available at the document level.class
This class holds all of the name trees that are available at the document level.class
A page in a PDF document.class
The page tree, which defines the ordering of pages in the document in an efficient manner.final class
A set of resources available at the page/pages/stream level.class
todo: JavaDocMethods in org.apache.pdfbox.pdmodel with parameters of type COSObjectableModifier and TypeMethodDescriptionprivate COSName
PDResources.add
(COSName kind, String prefix, COSObjectable object) Adds the given resource if it does not already exist.private void
PDResources.put
(COSName kind, COSName name, COSObjectable object) Sets the value of a given named resource. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.common
Classes in org.apache.pdfbox.pdmodel.common with type parameters of type COSObjectableModifier and TypeClassDescriptionclass
PDNameTreeNode<T extends COSObjectable>
This class represents a node in a name tree.Subinterfaces of COSObjectable in org.apache.pdfbox.pdmodel.commonModifier and TypeInterfaceDescriptioninterface
This is an interface used for some elements such as the document OpenAction that can be either a Destination or an Action.Classes in org.apache.pdfbox.pdmodel.common that implement COSObjectableModifier and TypeClassDescriptionclass
A wrapper for a COS dictionary.class
This class represents metadata for various objects in a PDF document.class
PDNameTreeNode<T extends COSObjectable>
This class represents a node in a name tree.class
This class represents a PDF Number tree.class
A PDStream represents a stream in a PDF document.class
Contains information for a page label range.class
Represents the page label dictionary of a document.class
This class will be used to signify a range.class
A rectangle in a PDF document.class
A PDStream represents a stream in a PDF document.class
A wrapper for a COS dictionary including Type information.Fields in org.apache.pdfbox.pdmodel.common with type parameters of type COSObjectableModifier and TypeFieldDescriptionprivate Class<? extends COSObjectable>
PDNumberTreeNode.valueType
Methods in org.apache.pdfbox.pdmodel.common that return COSObjectableModifier and TypeMethodDescriptionprotected COSObjectable
PDNumberTreeNode.convertCOSToPD
(COSBase base) Method to convert the COS value in the number tree to the PD Model object.Methods in org.apache.pdfbox.pdmodel.common that return types with arguments of type COSObjectableModifier and TypeMethodDescriptionPDNumberTreeNode.getNumbers()
This will return a map of numbers.Method parameters in org.apache.pdfbox.pdmodel.common with type arguments of type COSObjectableModifier and TypeMethodDescriptionvoid
PDNumberTreeNode.setNumbers
(Map<Integer, ? extends COSObjectable> numbers) Set the numbers for this node.Constructor parameters in org.apache.pdfbox.pdmodel.common with type arguments of type COSObjectableModifierConstructorDescriptionPDNumberTreeNode
(Class<? extends COSObjectable> valueClass) Constructor.PDNumberTreeNode
(COSDictionary dict, Class<? extends COSObjectable> valueClass) Constructor. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.common.filespecification
Classes in org.apache.pdfbox.pdmodel.common.filespecification that implement COSObjectableModifier and TypeClassDescriptionclass
This represents a file specification.class
This represents an embedded file in a file specification.class
This represents a file specification.class
A file specification that is just a string. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.common.function
Classes in org.apache.pdfbox.pdmodel.common.function that implement COSObjectableModifier and TypeClassDescriptionclass
This class represents a function in a PDF document.class
This class represents a type 0 function in a PDF document.class
This class represents a Type 2 (exponential interpolation) function in a PDF document.class
This class represents a Type 3 (stitching) function in a PDF document.class
This class represents a Type 4 (PostScript calculator) function in a PDF document.class
The identity function. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure
Classes in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure that implement COSObjectableModifier and TypeClassDescriptionclass
An attribute object.class
A default attribute object.class
A marked-content reference.class
The MarkInfo provides additional information relevant to specialized uses of structured documents.class
An object reference.class
Described in the PDF specification in the ParentTree segment of the table "Entries in the structure tree root".class
A structure element.class
A node in the structure tree.class
A root of a structure tree.class
A User attribute object.class
A user property.Fields in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure declared as COSObjectableMethods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure that return COSObjectableModifier and TypeMethodDescriptionprivate COSObjectable
PDStructureNode.createObjectFromDic
(COSDictionary kidDic) PDObjectReference.getReferencedObject()
Gets a higher-level object for the referenced object.Methods in org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure with parameters of type COSObjectableModifier and TypeMethodDescriptionprotected void
PDStructureNode.appendObjectableKid
(COSObjectable objectable) Appends an objectable kid.protected void
PDStructureNode.insertObjectableBefore
(COSObjectable newKid, Object refKid) Inserts an objectable kid before a reference kid.protected boolean
PDStructureNode.removeObjectableKid
(COSObjectable objectable) Removes an objectable kid. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent
Classes in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent that implement COSObjectableModifier and TypeClassDescriptionclass
A property list is a dictionary containing private information meaningful to the conforming writer creating the marked content. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.documentinterchange.prepress
Classes in org.apache.pdfbox.pdmodel.documentinterchange.prepress that implement COSObjectableModifier and TypeClassDescriptionclass
The Box Style specifies visual characteristics for displaying box areas. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf
Classes in org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf that implement COSObjectableModifier and TypeClassDescriptionclass
An Export Format attribute object.class
An object for four colours.class
A Layout attribute object.class
A List attribute object.class
A PrintField attribute object.class
A standard attribute object.class
A Table attribute object. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.encryption
Classes in org.apache.pdfbox.pdmodel.encryption that implement COSObjectableModifier and TypeClassDescriptionclass
This class is a specialized view of the crypt filter dictionary of a PDF document.class
This class is a specialized view of the encryption dictionary of a PDF document.class
Deprecated. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.fdf
Classes in org.apache.pdfbox.pdmodel.fdf that implement COSObjectableModifier and TypeClassDescriptionclass
This represents an FDF annotation that is part of the FDF document.class
This represents a Caret FDF annotation.class
This represents a Circle FDF annotation.class
This represents a FileAttachment FDF annotation.class
This represents a FreeText FDF annotation.class
This represents a Highlight FDF annotation.class
This represents a Ink FDF annotation.class
This represents a Line FDF annotation.class
This represents a Polygon FDF annotation.class
This represents a Polygon FDF annotation.class
This represents a Polyline FDF annotation.class
This represents a Sound FDF annotation.class
This represents a Square FDF annotation.class
This represents a Squiggly FDF annotation.class
This represents a Stamp FDF annotation.class
This represents a StrikeOut FDF annotation.class
This represents a Text FDF annotation.class
This abstract class is used as a superclass for the different FDF annotations with text markup attributes.class
This represents a Underline FDF annotation.class
This represents an FDF catalog that is part of the FDF document.class
This represents an FDF dictionary that is part of the FDF document.class
This represents an FDF field that is part of the FDF document.class
This represents an Icon fit dictionary for an FDF field.class
This represents an FDF JavaScript dictionary that is part of the FDF document.class
This represents an FDF named page reference that is part of the FDF field.class
This represents an object that can be used in a Field's Opt entry to represent an available option and a default appearance string.class
This represents an FDF page that is part of the FDF document.class
This represents an FDF page info that is part of the FDF page.class
This represents an FDF template that is part of the FDF page. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.font
Classes in org.apache.pdfbox.pdmodel.font that implement COSObjectableModifier and TypeClassDescriptionclass
A CIDFont.class
Type 0 CIDFont (CFF).class
Type 2 CIDFont (TrueType).final class
Represents a CIDSystemInfo.class
This is the base class for all PDF fonts.final class
A font descriptor.class
Type 1 Multiple Master Font.class
A simple font.class
TrueType font.class
A Composite (Type 0) font.class
Type 1-equivalent CFF font.class
A PostScript Type 1 Font.final class
A Type 3 character procedure.class
A PostScript Type 3 Font. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.font.encoding
Classes in org.apache.pdfbox.pdmodel.font.encoding that implement COSObjectableModifier and TypeClassDescriptionclass
A font's built-in encoding.class
This will perform the encoding from a dictionary.class
A PostScript encoding vector, maps character codes to glyph names.class
This is an interface to a text encoder.class
This is the Mac OS Roman encoding, which is similar to the MacRomanEncoding with the addition of 15 entriesclass
This is an interface to a text encoder.class
This is an interface to a text encoder.class
This is an interface to a text encoder.class
An encoding for a Type 1 font.class
This the win ansi encoding.class
This is an interface to a text encoder. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics
Classes in org.apache.pdfbox.pdmodel.graphics that implement COSObjectableModifier and TypeClassDescriptionclass
This class represents a font setting used for the graphics state.final class
A line dash pattern for stroking paths.class
A PostScript XObject.class
An external object, or "XObject". -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.color
Classes in org.apache.pdfbox.pdmodel.graphics.color that implement COSObjectableModifier and TypeClassDescriptionfinal class
A CalGray colour space is a special case of a single-component CIE-based colour space.class
A CalRGB colour space is a CIE-based colour space with one transformation stage instead of two.class
CIE-based colour spaces specify colours in a way that is independent of the characteristics of any particular output device.class
CIE-based colour spaces that use a dictionary.class
A color space specifies how the colours of graphics objects will be painted on the page.class
Allows colors to be specified according to the subtractive CMYK (cyan, magenta, yellow, black) model typical of printers and other paper-based output devices.class
Device colour spaces directly specify colours or shades of gray produced by an output device.final class
A color space with black, white, and intermediate shades of gray.class
DeviceN colour spaces may contain an arbitrary number of colour components.final class
Colours in the DeviceRGB colour space are specified according to the additive RGB (red-green-blue) colour model.final class
A gamma array, or collection of three floating point parameters used for color operations.final class
ICCBased color spaces are based on a cross-platform color profile as defined by the International Color Consortium (ICC).final class
An Indexed colour space specifies that an area is to be painted using a colour table of arbitrary colours from another color space.final class
A color space embedded in a JPX file.final class
A Lab colour space is a CIE-based ABC colour space with two transformation stages.final class
An Output Intent describes the colour reproduction characteristics of a possible output device or production condition.final class
A Pattern color space is either a Tiling pattern or a Shading pattern.class
A Separation color space used to specify either additional colorants or for isolating the control of individual colour components of a device colour space for a subtractive device.class
Special colour spaces add features or properties to an underlying colour space.final class
A tristimulus, or collection of three floating point parameters used for color operations. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.form
Classes in org.apache.pdfbox.pdmodel.graphics.form that implement COSObjectableModifier and TypeClassDescriptionclass
A Form XObject.class
A transparency group.final class
Transparency group attributes. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.image
Subinterfaces of COSObjectable in org.apache.pdfbox.pdmodel.graphics.imageClasses in org.apache.pdfbox.pdmodel.graphics.image that implement COSObjectableModifier and TypeClassDescriptionfinal class
An Image XObject.final class
An inline image object which uses a special syntax to express the data for a small image directly within the content stream. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.optionalcontent
Classes in org.apache.pdfbox.pdmodel.graphics.optionalcontent that implement COSObjectableModifier and TypeClassDescriptionclass
An optional content group (OCG).class
An optional content membership dictionary (OCMD).class
This class represents the optional content properties dictionary. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.pattern
Classes in org.apache.pdfbox.pdmodel.graphics.pattern that implement COSObjectableModifier and TypeClassDescriptionclass
This class wraps a pattern dictionary.class
A shading pattern dictionary.class
A tiling pattern dictionary. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.shading
Classes in org.apache.pdfbox.pdmodel.graphics.shading that implement COSObjectableModifier and TypeClassDescription(package private) class
Common resources for shading types 6 and 7class
A Shading Resource.class
Resources for a function based shading.class
Resources for an axial shading.class
Resources for a radial shading.class
Resources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Mesh).class
Resources for a shading type 5 (Lattice-Form Gouraud-Shade Triangle Mesh).class
Resources for a shading type 6 (Coons Patch Mesh).class
Resources for a shading type 7 (Tensor-Product Patch Mesh).(package private) class
Common resources for shading types 4,5,6 and 7 -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.graphics.state
Classes in org.apache.pdfbox.pdmodel.graphics.state that implement COSObjectableModifier and TypeClassDescriptionclass
An extended graphics state dictionary.final class
Soft mask. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.action
Classes in org.apache.pdfbox.pdmodel.interactive.action that implement COSObjectableModifier and TypeClassDescriptionclass
This represents an action that can be executed in a PDF document.class
This represents a embedded go-to action that can be executed in a PDF document.class
This represents a go-to action that can be executed in a PDF document.class
This represents a thread action that can be executed in a PDF document.class
class
This represents a JavaScript action.class
This represents a launch action that can be executed in a PDF document.class
class
This represents a named action in a PDF document.class
This represents a remote go-to action that can be executed in a PDF document.class
class
This represents a Sound action that can be executed in a PDF documentclass
This represents a Submit-Form action that can be executed in a PDF document.class
This represents a thread action that can be executed in a PDF document.class
This represents a URI action that can be executed in a PDF document.class
This represents a dictionary of actions that occur due to events.class
This class represents an annotation's dictionary of actions that occur due to events.class
This class represents a document catalog's dictionary of actions that occur due to events.class
This class represents a form field's dictionary of actions that occur due to events.class
This class represents a page object's dictionary of actions that occur due to events.class
A target dictionary specifying path information to the target document.class
This is the implementation of an URI dictionary.class
Launch parameters for the windows OS. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.annotation
Classes in org.apache.pdfbox.pdmodel.interactive.annotation that implement COSObjectableModifier and TypeClassDescriptionclass
A PDF annotation.class
This is the class that represents a file attachment.class
This is the class that represents a line annotation.class
This is the class that represents a link annotation.class
This class represents the additional fields of a Markup type Annotation.class
This is the class that represents a popup annotation.class
This is the class that represents a rubber stamp annotation.class
This is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .class
This is the class that represents a text annotation.class
This is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.class
This is the class that represents an arbitrary Unknown Annotation type.class
This is the class that represents a widget annotation.class
This class represents an appearance characteristics dictionary.class
An appearance dictionary specifying how the annotation shall be presented visually on the page.class
An entry in an appearance dictionary.class
An appearance stream is a form XObject, a self-contained content stream that shall be rendered inside the annotation rectangle.class
This class represents a PDF /BE entry the border effect dictionary.class
This class represents a PDF /BS entry the border style dictionary.class
This class represents an external data dictionary. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.digitalsignature
Classes in org.apache.pdfbox.pdmodel.interactive.digitalsignature that implement COSObjectableModifier and TypeClassDescriptionclass
A signature build dictionary as specified in the PDF Signature Build Dictionary Specification.class
The general property dictionaries from the build property dictionary.class
This represents a pdf signature seed value dictionary.class
This class represents a certificate seed value dictionary that is in the seed value which puts constraints on certificates when signing documents.class
This represents a digital signature that can be attached to a document. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.form
Classes in org.apache.pdfbox.pdmodel.interactive.form that implement COSObjectableModifier and TypeClassDescriptionfinal class
An interactive form, also known as an AcroForm.class
A button field represents an interactive control on the screen that the user can manipulate with the mouse.final class
A check box toggles between two states, on and off.class
A choice field contains several text items, one or more of which shall be selected as the field value.final class
A combo box consisting of a drop-down list.class
A field in an interactive form.final class
A scrollable list box.class
A non terminal field in an interactive form.class
A pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.final class
Radio button fields contain a set of related buttons that can each be on or off.class
A signature field is a form field that contains a digital signature.class
A field in an interactive form.final class
A text field is a box or space for text fill-in data typically entered from a keyboard.class
Base class for fields which use "Variable Text".final class
An XML Forms Architecture (XFA) resource. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.measurement
Classes in org.apache.pdfbox.pdmodel.interactive.measurement that implement COSObjectableModifier and TypeClassDescriptionclass
This class represents a measure dictionary.class
This class represents a number format dictionary.class
This class represents a rectlinear measure dictionary.class
This class represents a viewport dictionary. -
Uses of COSObjectable in org.apache.pdfbox.pdmodel.interactive.viewerpreferences
Classes in org.apache.pdfbox.pdmodel.interactive.viewerpreferences that implement COSObjectableModifier and TypeClassDescriptionclass
This is the document viewing preferences. -
Uses of COSObjectable in org.apache.pdfbox.preflight
Fields in org.apache.pdfbox.preflight with type parameters of type COSObjectableMethods in org.apache.pdfbox.preflight with parameters of type COSObjectableModifier and TypeMethodDescriptionvoid
PreflightContext.addToProcessedSet
(COSObjectable cos) Add the argument to the set of processed elements,boolean
PreflightContext.isInProcessedSet
(COSObjectable cos) Tell if the argument is in the set of processed elements.
PDEncryption
instead