Uses of Interface
org.sejda.sambox.cos.COSObjectable
Packages that use COSObjectable
Package
Description
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 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.sejda.sambox.cos
Subinterfaces of COSObjectable in org.sejda.sambox.cosModifier and TypeInterfaceDescriptioninterfaceACOSObjectablethat can be disposed once no longer need.Classes in org.sejda.sambox.cos that implement COSObjectableModifier and TypeClassDescriptionclassAn array of PDFBase objects as part of the PDF document.classThe base object that all objects in the PDF document will extend.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 stream object in a PDF document.final classA string object, which may be a text string, a PDFDocEncoded string, ASCII string, or byte string.final classA COSBase that will be written as direct objectclassA COSBase that will be written as indirect object.classA disposable indirect object reference.classAnIndirectCOSObjectReferencethat cannot be stored into object streamsMethods in org.sejda.sambox.cos with parameters of type COSObjectableModifier and TypeMethodDescriptionvoidCOSArray.add(int index, COSObjectable object) Add an object at the index location and push the rest to the right.booleanCOSArray.add(COSObjectable object) Add an object to the arraystatic DirectCOSObjectDirectCOSObject.asDirectObject(COSObjectable wrapped) Factory method for an object that will be written as a direct object.static IndirectCOSObjectIndirectCOSObject.asIndirectObject(COSObjectable wrapped) Factory method for an object that will be written as an indirect object.voidCOSDictionary.putIfAbsent(COSName key, COSObjectable value) voidCOSArray.set(int index, COSObjectable object) Set an object at a specific index.voidCOSDictionary.setItem(String key, COSObjectable value) Set the wrappedCOSBaseas item in the dictionary.voidCOSDictionary.setItem(COSName key, COSObjectable value) Set the wrappedCOSBaseas item in the dictionary. -
Uses of COSObjectable in org.sejda.sambox.input
Classes in org.sejda.sambox.input that implement COSObjectableModifier and TypeClassDescriptionclassAn indirect object belonging to an existing pdf document.Methods in org.sejda.sambox.input with parameters of type COSObjectableModifier and TypeMethodDescriptionbooleanIncrementablePDDocument.modified(COSObjectable modified) Adds the given object as modified, this object will be written as part of the incremental update.voidIncrementablePDDocument.newIndirect(COSObjectable newObject) Adds the given object to the set of the new indirect objects.voidIncrementablePDDocument.replace(IndirectCOSObjectIdentifier toReplace, COSObjectable replacement) Replaces the object with the givenIndirectCOSObjectIdentifierduring the incremental update -
Uses of COSObjectable in org.sejda.sambox.output
Methods in org.sejda.sambox.output with parameters of type COSObjectableModifier and TypeMethodDescriptionvoidExistingPagesSizePredictor.addIndirectReferenceFor(COSObjectable value) Adds theCOSObjectableto the predicted size. -
Uses of COSObjectable in org.sejda.sambox.pdmodel
Classes in org.sejda.sambox.pdmodel that implement COSObjectableModifier and TypeClassDescriptionclassThis class holds all of the name trees that are available at the document level.classThe Document Catalog of a PDF.classThis is the document metadata.classThis encapsulates the "dictionary of names and corresponding destinations" for the /Desta entry in the document catalog.classThis class holds all of the name trees that are available at the document level.classThis class holds all of the name trees that are available at the document level.classThis class holds all of the name trees that are available at the document level.classA page in a PDF document.classThe page tree, which defines the ordering of pages in the document in an efficient manner.final classA set of resources available at the page/pages/stream level.classtodo: JavaDoc -
Uses of COSObjectable in org.sejda.sambox.pdmodel.common
Classes in org.sejda.sambox.pdmodel.common with type parameters of type COSObjectableModifier and TypeClassDescriptionclassPDNameTreeNode<T extends COSObjectable>This class represents a node in a name tree.Subinterfaces of COSObjectable in org.sejda.sambox.pdmodel.commonModifier and TypeInterfaceDescriptioninterfaceThis is an interface used for some elements such as the document OpenAction that can be either a Destination or an Action.Classes in org.sejda.sambox.pdmodel.common that implement COSObjectableModifier and TypeClassDescriptionclassA wrapper for a COS dictionary.classThis class represents metadata for various objects in a PDF document.classPDNameTreeNode<T extends COSObjectable>This class represents a node in a name tree.classThis class represents a PDF Number tree.classA PDStream represents a stream in a PDF document.classContains information for a page label range.classRepresents the page label dictionary of a document.classThis class will be used to signify a range.classA rectangle in a PDF document.classA PDStream represents a stream in a PDF document.classA wrapper for a COS dictionary including Type information.Methods in org.sejda.sambox.pdmodel.common that return COSObjectableModifier and TypeMethodDescriptionprotected COSObjectablePDNumberTreeNode.convertCOSToPD(COSBase base) Method to convert the COS value in the name tree to the PD Model object.Methods in org.sejda.sambox.pdmodel.common that return types with arguments of type COSObjectableModifier and TypeMethodDescriptionPDNumberTreeNode.getNumbers()This will return a map of numbers.Method parameters in org.sejda.sambox.pdmodel.common with type arguments of type COSObjectableModifier and TypeMethodDescriptionvoidPDNumberTreeNode.setNumbers(Map<Integer, ? extends COSObjectable> numbers) Set the names of for this node.Constructor parameters in org.sejda.sambox.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.sejda.sambox.pdmodel.common.filespecification
Subinterfaces of COSObjectable in org.sejda.sambox.pdmodel.common.filespecificationModifier and TypeInterfaceDescriptioninterfaceThis represents a file specification.Classes in org.sejda.sambox.pdmodel.common.filespecification that implement COSObjectableModifier and TypeClassDescriptionclassThis represents a file specification.classThis represents an embedded file in a file specification.classA file specification that is just a string. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.common.function
Classes in org.sejda.sambox.pdmodel.common.function that implement COSObjectableModifier and TypeClassDescriptionclassThis class represents a function in a PDF document.classThis class represents a type 0 function in a PDF document.classThis class represents a Type 2 (exponential interpolation) function in a PDF document.classThis class represents a Type 3 (stitching) function in a PDF document.classThis class represents a Type 4 (PostScript calculator) function in a PDF document.classThe identity function. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.documentinterchange.logicalstructure
Classes in org.sejda.sambox.pdmodel.documentinterchange.logicalstructure that implement COSObjectableModifier and TypeClassDescriptionclassAn attribute object.classA default attribute object.classA marked-content reference.classThe MarkInfo provides additional information relevant to specialized uses of structured documents.classAn object reference.classDescribed in the PDF specification in the ParentTree segment of the table "Entries in the structure tree root".classA structure element.classA node in the structure tree.classA root of a structure tree.classA User attribute object.classA user property.Methods in org.sejda.sambox.pdmodel.documentinterchange.logicalstructure that return COSObjectableModifier and TypeMethodDescriptionPDObjectReference.getReferencedObject()Gets a higher-level object for the referenced object.Methods in org.sejda.sambox.pdmodel.documentinterchange.logicalstructure with parameters of type COSObjectableModifier and TypeMethodDescriptionprotected voidPDStructureNode.appendObjectableKid(COSObjectable objectable) Appends an objectable kid.protected voidPDStructureNode.insertObjectableBefore(COSObjectable newKid, Object refKid) Inserts an objectable kid before a reference kid.protected booleanPDStructureNode.removeObjectableKid(COSObjectable objectable) Removes an objectable kid. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.documentinterchange.markedcontent
Classes in org.sejda.sambox.pdmodel.documentinterchange.markedcontent that implement COSObjectableModifier and TypeClassDescriptionclassA property list is a dictionary containing private information meaningful to the conforming writer creating the marked content. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.documentinterchange.prepress
Classes in org.sejda.sambox.pdmodel.documentinterchange.prepress that implement COSObjectableModifier and TypeClassDescriptionclassThe Box Style specifies visual characteristics for displaying box areas. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.documentinterchange.taggedpdf
Classes in org.sejda.sambox.pdmodel.documentinterchange.taggedpdf that implement COSObjectableModifier and TypeClassDescriptionclassAn Export Format attribute object.classAn object for four colours.classA Layout attribute object.classA List attribute object.classA PrintField attribute object.classA standard attribute object.classA Table attribute object. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.encryption
Classes in org.sejda.sambox.pdmodel.encryption that implement COSObjectableModifier and TypeClassDescriptionclassThis class is a specialized view of the crypt filter dictionary of a PDF document.classThis class is a specialized view of the encryption getCOSObject() of a PDF document. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.font
Classes in org.sejda.sambox.pdmodel.font that implement COSObjectableModifier and TypeClassDescriptionclassA CIDFont.classType 0 CIDFont (CFF).classType 2 CIDFont (TrueType).final classRepresents a CIDSystemInfo.classThis is the base class for all PDF fonts.final classA font descriptor.classType 1 Multiple Master Font.classA simple font.classTrueType font.classA Composite (Type 0) font.classType 1-equivalent CFF font.classA PostScript Type 1 Font.final classA Type 3 character procedure.classA PostScript Type 3 Font. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.font.encoding
Classes in org.sejda.sambox.pdmodel.font.encoding that implement COSObjectableModifier and TypeClassDescriptionclassA font's built-in encoding.classThis will perform the encoding from a dictionary.classA PostScript encoding vector, maps character codes to glyph names.classThis is an interface to a text encoder.classThis is the Mac OS Roman encoding, which is similar to the MacRomanEncoding with the addition of 15 entriesclassThis is an interface to a text encoder.classThis is an interface to a text encoder.classThis is an interface to a text encoder.classAn encoding for a Type 1 font.classThis the win ansi encoding.classThis is an interface to a text encoder. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics
Classes in org.sejda.sambox.pdmodel.graphics that implement COSObjectableModifier and TypeClassDescriptionclassThis class represents a font setting used for the graphics state.final classA line dash pattern for stroking paths.classA PostScript XObject.classAn external object, or "XObject". -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.color
Classes in org.sejda.sambox.pdmodel.graphics.color that implement COSObjectableModifier and TypeClassDescriptionfinal classA CalGray colour space is a special case of a single-component CIE-based colour space.classA CalRGB colour space is a CIE-based colour space with one transformation stage instead of two.classCIE-based colour spaces specify colours in a way that is independent of the characteristics of any particular output device.classCIE-based colour spaces that use a dictionary.classA color space specifies how the colours of graphics objects will be painted on the page.classAllows colors to be specified according to the subtractive CMYK (cyan, magenta, yellow, black) model typical of printers and other paper-based output devices.classDevice colour spaces directly specify colours or shades of gray produced by an output device.final classA color space with black, white, and intermediate shades of gray.classDeviceN colour spaces may contain an arbitrary number of colour components.final classContains additional information about the components of colour space.final classColours in the DeviceRGB colour space are specified according to the additive RGB (red-green-blue) colour model.final classA gamma array, or collection of three floating point parameters used for color operations.final classICCBased colour spaces are based on a cross-platform colour profile as defined by the International Color Consortium (ICC).final classAn Indexed colour space specifies that an area is to be painted using a colour table of arbitrary colours from another color space.final classA color space embedded in a JPX file.final classA Lab colour space is a CIE-based ABC colour space with two transformation stages.final classAn Output Intent describes the colour reproduction characteristics of a possible output device or production condition.final classA Pattern color space is either a Tiling pattern or a Shading pattern.classA 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.classSpecial colour spaces add features or properties to an underlying colour space.final classA tristimulus, or collection of three floating point parameters used for color operations. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.form
Classes in org.sejda.sambox.pdmodel.graphics.form that implement COSObjectableModifier and TypeClassDescriptionclassA Form XObject.classA transparency group.final classTransparency group attributes. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.image
Subinterfaces of COSObjectable in org.sejda.sambox.pdmodel.graphics.imageClasses in org.sejda.sambox.pdmodel.graphics.image that implement COSObjectableModifier and TypeClassDescriptionfinal classAn Image XObject.final classAn 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.sejda.sambox.pdmodel.graphics.optionalcontent
Classes in org.sejda.sambox.pdmodel.graphics.optionalcontent that implement COSObjectableModifier and TypeClassDescriptionclassAn optional content group (OCG).classAn optional content membership dictionary (OCMD).classThis class represents the optional content properties dictionary. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.pattern
Classes in org.sejda.sambox.pdmodel.graphics.pattern that implement COSObjectableModifier and TypeClassDescriptionclassA Pattern dictionary from a page's resources.classA shading pattern dictionary.classA tiling pattern dictionary. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.shading
Classes in org.sejda.sambox.pdmodel.graphics.shading that implement COSObjectableModifier and TypeClassDescriptionclassA Shading Resource.classResources for a function based shading.classResources for an axial shading.classResources for a radial shading.classResources for a shading type 4 (Free-Form Gouraud-Shaded Triangle Mesh).classResources for a shading type 5 (Lattice-Form Gouraud-Shade Triangle Mesh).classResources for a shading type 6 (Coons Patch Mesh).classResources for a shading type 7 (Tensor-Product Patch Mesh). -
Uses of COSObjectable in org.sejda.sambox.pdmodel.graphics.state
Classes in org.sejda.sambox.pdmodel.graphics.state that implement COSObjectableModifier and TypeClassDescriptionclassAn extended graphics state dictionary.final classSoft mask. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.interactive.action
Classes in org.sejda.sambox.pdmodel.interactive.action that implement COSObjectableModifier and TypeClassDescriptionclassThis represents an action that can be executed in a PDF document.classThis represents a embedded go-to action that can be executed in a PDF document.classThis represents a go-to action that can be executed in a PDF document.classThis represents a thread action that can be executed in a PDF document.classclassThis represents a JavaScript action.classThis represents a launch action that can be executed in a PDF document.classclassThis represents a named action in a PDF document.classThis represents a remote go-to action that can be executed in a PDF document.classclassThis represents a Sound action that can be executed in a PDF documentclassThis represents a Submit-Form action that can be executed in a PDF document.classThis represents a thread action that can be executed in a PDF document.classThis represents a URI action that can be executed in a PDF document.classThis represents a dictionary of actions that occur due to events.classThis class represents an annotation's dictionary of actions that occur due to events.classThis class represents a document catalog's dictionary of actions that occur due to events.classThis class represents a form field's dictionary of actions that occur due to events.classThis class represents a page object's dictionary of actions that occur due to events.classA target dictionary specifying path information to the target document.classThis is the implementation of an URI dictionary.classLaunch paramaters for the windows OS. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.interactive.annotation
Classes in org.sejda.sambox.pdmodel.interactive.annotation that implement COSObjectableModifier and TypeClassDescriptionclassA PDF annotation.classThis is the class that represents a file attachement.classThis is the class that represents a line annotation.classThis is the class that represents a link annotation.classThis class represents the additonal fields of a Markup type Annotation.classThis is the class that represents a popup annotation.classThis is the class that represents a rubber stamp annotation.classThis is the class that represents a rectangular or eliptical annotation Introduced in PDF 1.3 specification .classThis is the class that represents a text annotation.classThis is the abstract class that represents a text markup annotation Introduced in PDF 1.3 specification, except Squiggly lines in 1.4.classThis is the class that represents an arbitary Unknown Annotation type.classThis is the class that represents a widget.classThis class represents an appearance characteristics dictionary.classAn appearance dictionary specifying how the annotation shall be presented visually on the page.classAn entry in an appearance dictionary.classAn appearance stream is a form XObject, a self-contained content stream that shall be rendered inside the annotation rectangle.classThis class represents a PDF /BE entry the border effect dictionary.classThis class represents a PDF /BS entry the border style dictionary.classThis class represents an external data dictionary. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.interactive.form
Classes in org.sejda.sambox.pdmodel.interactive.form that implement COSObjectableModifier and TypeClassDescriptionfinal classAn interactive form, also known as an AcroForm.classA button field represents an interactive control on the screen that the user can manipulate with the mouse.final classA check box toggles between two states, on and off.classA choice field contains several text items, one or more of which shall be selected as the field value.final classA combo box consisting of a drop-down list.classA field in an interactive form.final classA scrollable list box.classA non terminal field in an interactive form.classA pushbutton is a purely interactive control that responds immediately to user input without retaining a permanent value.final classRadio button fields contain a set of related buttons that can each be on or off.classA signature field is a form field that contains a digital signature.classA field in an interactive form.final classA text field is a box or space for text fill-in data typically entered from a keyboard.classBase class for fields which use "Variable Text".final classAn XML Forms Architecture (XFA) resource. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.interactive.measurement
Classes in org.sejda.sambox.pdmodel.interactive.measurement that implement COSObjectableModifier and TypeClassDescriptionclassThis class represents a measure dictionary.classThis class represents a number format dictionary.classThis class represents a rectlinear measure dictionary.classThis class represents a viewport dictionary. -
Uses of COSObjectable in org.sejda.sambox.pdmodel.interactive.viewerpreferences
Classes in org.sejda.sambox.pdmodel.interactive.viewerpreferences that implement COSObjectableModifier and TypeClassDescriptionclassThis is the document viewing preferences. -
Uses of COSObjectable in org.sejda.sambox.util
Methods in org.sejda.sambox.util with parameters of type COSObjectable -
Uses of COSObjectable in org.sejda.sambox.xref
Classes in org.sejda.sambox.xref that implement COSObjectableModifier and TypeClassDescriptionclassFile trailer with information regarding the xref offset