Uses of Class
org.apache.pdfbox.cos.COSName

Packages that use COSName

org.apache.pdfbox	This package holds executable classes that interact with the PDFBox application.
org.apache.pdfbox.cos	These are the low level objects that make up a PDF document.
org.apache.pdfbox.encoding	This package contains the implementations for all of the encodings that are used in PDF documents.
org.apache.pdfbox.filter	This package will hold the PDFBox implementations of the filters that are used in PDF documents.
org.apache.pdfbox.pdfparser	The pdfparser package contains classes to parse PDF documents and objects within the document.
org.apache.pdfbox.pdfviewer	The pdfviewer package contains classes to graphically display information about a PDF document.
org.apache.pdfbox.pdfwriter	This is the persistence layer used to write the PDFBox documents to a stream.
org.apache.pdfbox.pdmodel.common	High level PD classes that are used throughout several packages are placed in the PDModel common package.
org.apache.pdfbox.pdmodel.documentinterchange.markedcontent	The marked content package provides a mechanism for modeling marked-content sequences.
org.apache.pdfbox.pdmodel.encryption	The encryption package will handle the PDF document security handlers and the functionality of pluggable security handlers.
org.apache.pdfbox.pdmodel.graphics	The PDModel graphics package deals with graphics states, operations, and parameters within the PDF document.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination	The destination package allows destinations into a pdf document to be specified.
org.apache.pdfbox.util	This package contains utility classes that are used by the PDFBox project.

Uses of COSName in org.apache.pdfbox

Fields in org.apache.pdfbox declared as COSName

static COSName	Overlay.EXT_G_STATE Deprecated. use the EXT_G_STATE constant instead
static COSName	Overlay.PROC_SET Deprecated. use the PROC_SET constant instead
static COSName	Overlay.XOBJECT Deprecated. use the XOBJECT constant instead

Uses of COSName in org.apache.pdfbox.cos

Fields in org.apache.pdfbox.cos declared as COSName

static COSName	COSName.A A common COSName value.
static COSName	COSName.AA A common COSName value.
static COSName	COSName.ACRO_FORM A common COSName value.
static COSName	COSName.ACTUAL_TEXT "ActualText"
static COSName	COSName.AIS A common COSName value.
static COSName	COSName.ALT "Alt"
static COSName	COSName.ALTERNATE "Alt"
static COSName	COSName.ANNOTS A common COSName value.
static COSName	COSName.AP "AP"
static COSName	COSName.ART_BOX A common COSName value.
static COSName	COSName.ARTIFACT "Artifact"
static COSName	COSName.ASCII_HEX_DECODE A common COSName value.
static COSName	COSName.ASCII_HEX_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.ASCII85_DECODE A common COSName value.
static COSName	COSName.ASCII85_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.ATTACHED "Attached"
static COSName	COSName.B A common COSName value.
static COSName	COSName.BASE_ENCODING A common COSName value.
static COSName	COSName.BASE_FONT A common COSName value.
static COSName	COSName.BBOX A common COSName value.
static COSName	COSName.BITS_PER_COMPONENT A common COSName value.
static COSName	COSName.BITS_PER_SAMPLE A common COSName value.
static COSName	COSName.BLACK_IS_1 A common COSName value.
static COSName	COSName.BLACK_POINT A common COSName value.
static COSName	COSName.BLEED_BOX A common COSName value.
static COSName	COSName.BOUNDS A common COSName value.
static COSName	COSName.BPC A common COSName value.
static COSName	COSName.C "C"
static COSName	COSName.C0 A common COSName value.
static COSName	COSName.C1 A common COSName value.
static COSName	COSName.CA A common COSName value.
static COSName	COSName.CA_NS A common COSName value.
static COSName	COSName.CALGRAY A common COSName value.
static COSName	COSName.CALRGB A common COSName value.
static COSName	COSName.CATALOG A common COSName value.
static COSName	COSName.CCITTFAX_DECODE A common COSName value.
static COSName	COSName.CCITTFAX_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.CF A common COSName value.
static COSName	COSName.CFM A common COSName value.
static COSName	COSName.CHAR_PROCS A common COSName value.
static COSName	COSName.CHAR_SET A common COSName value.
static COSName	COSName.CID_FONT_TYPE0 A common COSName value.
static COSName	COSName.CID_FONT_TYPE2 A common COSName value.
static COSName	COSName.CIDSYSTEMINFO A common COSName value.
static COSName	COSName.COLORANTS A common COSName value.
static COSName	COSName.COLORSPACE A common COSName value.
static COSName	COSName.COLUMNS A common COSName value.
static COSName	COSName.CONTENTS A common COSName value.
static COSName	COSName.COUNT A common COSName value.
static COSName	COSName.CROP_BOX A common COSName value.
static COSName	COSName.CRYPT The Crypt filter.
static COSName	COSName.CS A common COSName value.
static COSName	COSName.D "D"
static COSName	COSName.DCT_DECODE A common COSName value.
static COSName	COSName.DCT_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.DECODE A common COSName value.
static COSName	COSName.DECODE_PARMS "DecodeParms"
static COSName	COSName.DESCENDANT_FONTS A common COSName value.
static COSName	COSName.DEST A common COSName value.
static COSName	COSName.DESTS "Dests"
static COSName	COSName.DEVICECMYK A common COSName value.
static COSName	COSName.DEVICEGRAY A common COSName value.
static COSName	COSName.DEVICEN A common COSName value.
static COSName	COSName.DEVICERGB A common COSName value.
static COSName	COSName.DIFFERENCES A common COSName value.
static COSName	COSName.DL "DL"
static COSName	COSName.DOMAIN A common COSName value.
static COSName	COSName.DP "DP"
static COSName	COSName.DV A common COSName value.
static COSName	COSName.DW A common COSName value.
static COSName	COSName.E "E"
static COSName	COSName.EMBEDDED_FILES "EmbeddedFiles"
static COSName	COSName.ENCODE A common COSName value.
static COSName	COSName.ENCODING A common COSName value.
static COSName	COSName.ENCODING_90MS_RKSJ_H A common COSName value.
static COSName	COSName.ENCODING_90MS_RKSJ_V A common COSName value.
static COSName	COSName.ENCODING_ETEN_B5_H A common COSName value.
static COSName	COSName.ENCODING_ETEN_B5_V A common COSName value.
static COSName	COSName.ENCRYPT "Encrypt"
static COSName	COSName.EXT_G_STATE "ExtGState"
static COSName	COSName.EXTENDS "Extends"
static COSName	COSName.F "F"
static COSName	COSName.F_DECODE_PARMS "FDecodeParms"
static COSName	COSName.F_FILTER "FFilter"
static COSName	COSName.FIELDS A common COSName value.
static COSName	COSName.FILTER A common COSName value.
static COSName	COSName.FIRST_CHAR A common COSName value.
static COSName	COSName.FL A common COSName value.
static COSName	COSName.FLATE_DECODE A common COSName value.
static COSName	COSName.FLATE_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.FONT A common COSName value.
static COSName	COSName.FONT_BBOX A common COSName value.
static COSName	COSName.FONT_DESC A common COSName value.
static COSName	COSName.FONT_FAMILY A common COSName value.
static COSName	COSName.FONT_FILE A common COSName value.
static COSName	COSName.FONT_FILE2 A common COSName value.
static COSName	COSName.FONT_FILE3 A common COSName value.
static COSName	COSName.FONT_MATRIX A common COSName value.
static COSName	COSName.FONT_NAME A common COSName value.
static COSName	COSName.FONT_STRETCH A common COSName value.
static COSName	COSName.FORMTYPE A common COSName value.
static COSName	COSName.FRM A common COSName value.
static COSName	COSName.FUNCTION_TYPE A common COSName value.
static COSName	COSName.FUNCTIONS A common COSName value.
static COSName	COSName.GAMMA A common COSName value.
static COSName	COSName.H A common COSName value.
static COSName	COSName.HEIGHT A common COSName value.
static COSName	COSName.ICCBASED A common COSName value.
static COSName	COSName.ID "ID"
static COSName	COSName.ID_TREE "IDTree"
static COSName	COSName.IDENTITY A common COSName value.
static COSName	COSName.IDENTITY_H A common COSName value.
static COSName	COSName.IMAGE A common COSName value.
static COSName	COSName.IMAGE_MASK A common COSName value.
static COSName	COSName.INDEX "Index"
static COSName	COSName.INDEXED A common COSName value.
static COSName	COSName.INFO A common COSName value.
static COSName	COSName.JAVA_SCRIPT "JavaScript"
static COSName	COSName.JPX_DECODE A common COSName value.
static COSName	COSName.K "K"
static COSName	COSName.KIDS "Kids"
static COSName	COSName.LAB A common COSName value.
static COSName	COSName.LANG "Lang"
static COSName	COSName.LAST_CHAR A common COSName value.
static COSName	COSName.LC A common COSName value.
static COSName	COSName.LENGTH A common COSName value.
static COSName	COSName.LENGTH1 A common COSName value.
static COSName	COSName.LIMITS "Limits"
static COSName	COSName.LJ A common COSName value.
static COSName	COSName.LW A common COSName value.
static COSName	COSName.LZW_DECODE A common COSName value.
static COSName	COSName.LZW_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.MAC_ROMAN_ENCODING A common COSName value.
static COSName	COSName.MARK_INFO "MarkInfo"
static COSName	COSName.MATRIX A common COSName value.
static COSName	COSName.MCID "MCID"
static COSName	COSName.MEDIA_BOX A common COSName value.
static COSName	COSName.METADATA A common COSName value.
static COSName	COSName.ML A common COSName value.
static COSName	COSName.MM_TYPE1 A common COSName value.
static COSName	COSName.N A common COSName value.
static COSName	COSName.NAME A common COSName value.
static COSName	COSName.NAMES "Names"
static COSName	COSName.NUMS "Nums"
static COSName	COSName.O "O"
static COSName	COSName.OBJ "Obj"
static COSName	COSName.OP A common COSName value.
static COSName	COSName.OP_NS A common COSName value.
static COSName	COSName.OPEN_ACTION "OpenAction"
static COSName	COSName.OPM A common COSName value.
static COSName	COSName.ORDERING A common COSName value.
static COSName	COSName.OUTLINES "Outlines"
static COSName	COSName.P A common COSName value.
static COSName	COSName.PAGE A common COSName value.
static COSName	COSName.PAGE_LABELS "PageLabels"
static COSName	COSName.PAGE_LAYOUT "PageLayout"
static COSName	COSName.PAGE_MODE "PageMode"
static COSName	COSName.PAGES A common COSName value.
static COSName	COSName.PARENT A common COSName value.
static COSName	COSName.PARENT_TREE_NEXT_KEY "ParentTreeNextKey"
static COSName	COSName.PATTERN A common COSName value.
static COSName	COSName.PDF_DOC_ENCODING A common COSName value.
static COSName	COSName.PG "Pg"
static COSName	COSName.PREDICTOR A common COSName value.
static COSName	COSName.PREV A common COSName value.
static COSName	COSName.PROC_SET "ProcSet"
static COSName	COSName.R A common COSName value.
static COSName	COSName.RANGE A common COSName value.
static COSName	COSName.RECIPIENTS A common COSName value.
static COSName	COSName.REGISTRY A common COSName value.
static COSName	COSName.RESOURCES A common COSName value.
static COSName	COSName.RI "RoleMap"
static COSName	COSName.ROLE_MAP A common COSName value.
static COSName	COSName.ROOT A common COSName value.
static COSName	COSName.ROTATE A common COSName value.
static COSName	COSName.ROWS A common COSName value.
static COSName	COSName.RUN_LENGTH_DECODE A common COSName value.
static COSName	COSName.RUN_LENGTH_DECODE_ABBREVIATION A common COSName value.
static COSName	COSName.S "S"
static COSName	COSName.SA A common COSName value.
static COSName	COSName.SEPARATION A common COSName value.
static COSName	COSName.SHADING "Shading"
static COSName	COSName.SIZE "Size"
static COSName	COSName.SM A common COSName value.
static COSName	COSName.SMASK A common COSName value.
static COSName	COSName.STANDARD_ENCODING A common COSName value.
static COSName	COSName.STD_CF A common COSName value.
static COSName	COSName.STM_F A common COSName value.
static COSName	COSName.STR_F A common COSName value.
static COSName	COSName.STRUCT_TREE_ROOT "StructTreeRoot"
static COSName	COSName.SUB_FILTER A common COSName value.
static COSName	COSName.SUBTYPE A common COSName value.
static COSName	COSName.T "T"
static COSName	COSName.THREADS "Threads"
static COSName	COSName.TK A common COSName value.
static COSName	COSName.TO_UNICODE A common COSName value.
static COSName	COSName.TRIM_BOX A common COSName value.
static COSName	COSName.TRUE_TYPE A common COSName value.
static COSName	COSName.TYPE A common COSName value.
static COSName	COSName.TYPE0 A common COSName value.
static COSName	COSName.TYPE1 A common COSName value.
static COSName	COSName.TYPE3 A common COSName value.
static COSName	COSName.U A common COSName value.
static COSName	COSName.URI "URI"
static COSName	COSName.V A common COSName value.
static COSName	COSName.VERSION A common COSName value.
static COSName	COSName.VIEWER_PREFERENCES "ViewerPreferences"
static COSName	COSName.W A common COSName value.
static COSName	COSName.WHITE_POINT A common COSName value.
static COSName	COSName.WIDTH A common COSName value.
static COSName	COSName.WIDTHS A common COSName value.
static COSName	COSName.WIN_ANSI_ENCODING A common COSName value.
static COSName	COSName.XOBJECT "XObject"

Methods in org.apache.pdfbox.cos that return COSName

COSName	COSDictionary.getKeyForValue(Object value) Search in the map for the value that matches the parameter and return the first key that maps to that value.
static COSName	COSName.getPDFName(String aName) This will get a COSName object with that name.

Methods in org.apache.pdfbox.cos that return types with arguments of type COSName

Set<Map.Entry<COSName,COSBase>>	COSDictionary.entrySet() Returns the name-value entries in this dictionary.
List<COSName>	COSDictionary.keyList() Deprecated. Use the COSDictionary.entrySet() method instead.
Set<COSName>	COSDictionary.keySet() Returns the names of the entries in this dictionary.

Methods in org.apache.pdfbox.cos with parameters of type COSName

int	COSName.compareTo(COSName other)
boolean	COSDictionary.getBoolean(COSName key, boolean defaultValue) This is a convenience method that will get the dictionary object that is expected to be a COSBoolean and convert it to a primitive boolean.
Calendar	COSDictionary.getDate(COSName key) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
Calendar	COSDictionary.getDate(COSName key, Calendar defaultValue) This is a convenience method that will get the dictionary object that is expected to be a date.
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	COSDictionary.getDictionaryObject(COSName key) This will get an object from this dictionary.
Calendar	COSDictionary.getEmbeddedDate(String embedded, COSName key) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
Calendar	COSDictionary.getEmbeddedDate(String embedded, COSName key, Calendar defaultValue) This is a convenience method that will get the dictionary object that is expected to be a date.
int	COSDictionary.getEmbeddedInt(String embeddedDictionary, COSName key) Get an integer from an embedded dictionary.
int	COSDictionary.getEmbeddedInt(String embeddedDictionary, COSName key, int defaultValue) Get an integer from an embedded dictionary.
String	COSDictionary.getEmbeddedString(String embedded, COSName key) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
String	COSDictionary.getEmbeddedString(String embedded, COSName key, String defaultValue) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
float	COSDictionary.getFloat(COSName key) This is a convenience method that will get the dictionary object that is expected to be an float.
float	COSDictionary.getFloat(COSName key, float defaultValue) This is a convenience method that will get the dictionary object that is expected to be an float.
int	COSDictionary.getInt(COSName key) This is a convenience method that will get the dictionary object that is expected to be an int.
int	COSDictionary.getInt(COSName key, int defaultValue) This is a convenience method that will get the dictionary object that is expected to be an integer.
COSBase	COSObject.getItem(COSName key) This will get the dictionary object in this object that has the name key.
COSBase	COSDictionary.getItem(COSName key) This will do a lookup into the dictionary.
long	COSDictionary.getLong(COSName key) This is a convenience method that will get the dictionary object that is expected to be an long.
long	COSDictionary.getLong(COSName key, long defaultValue) This is a convenience method that will get the dictionary object that is expected to be an integer.
String	COSDictionary.getNameAsString(COSName key) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
String	COSDictionary.getNameAsString(COSName key, String defaultValue) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
COSObject	COSDocument.getObjectByType(COSName type) This will get the first dictionary object by type.
List<COSObject>	COSDocument.getObjectsByType(COSName type) This will get a dictionary object by type.
String	COSDictionary.getString(COSName key) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
String	COSDictionary.getString(COSName key, String defaultValue) This is a convenience method that will get the dictionary object that is expected to be a name and convert it to a string.
void	COSDictionary.removeItem(COSName key) This will remove an item for the dictionary.
void	COSDictionary.setBoolean(COSName key, boolean value) This will set an item in the dictionary.
void	COSDictionary.setDate(COSName key, Calendar date) Set the date object.
void	COSDictionary.setEmbeddedDate(String embedded, COSName key, Calendar date) Set the date object.
void	COSDictionary.setEmbeddedInt(String embeddedDictionary, COSName key, int value) This is a convenience method that will convert the value to a COSInteger object.
void	COSDictionary.setEmbeddedString(String embedded, COSName key, String value) This is a convenience method that will convert the value to a COSString object.
void	COSDictionary.setFloat(COSName key, float value) This is a convenience method that will convert the value to a COSFloat object.
void	COSDictionary.setInt(COSName key, int value) This is a convenience method that will convert the value to a COSInteger object.
void	COSDictionary.setItem(COSName key, COSBase 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	COSDictionary.setLong(COSName key, long value) This is a convenience method that will convert the value to a COSInteger object.
void	COSDictionary.setName(COSName key, String value) This is a convenience method that will convert the value to a COSName object.
void	COSDictionary.setString(COSName key, String value) This is a convenience method that will convert the value to a COSString object.
Object	ICOSVisitor.visitFromName(COSName obj) Notification of visit to name object.

Uses of COSName in org.apache.pdfbox.encoding

Methods in org.apache.pdfbox.encoding with parameters of type COSName

Encoding

EncodingManager.getEncoding(COSName name) This will get an encoding by name.

Uses of COSName in org.apache.pdfbox.filter

Methods in org.apache.pdfbox.filter with parameters of type COSName

void	FilterManager.addFilter(COSName filterName, Filter filter) This will add an available filter.
Filter	FilterManager.getFilter(COSName filterName) This will get a filter by name.

Uses of COSName in org.apache.pdfbox.pdfparser

Methods in org.apache.pdfbox.pdfparser that return COSName

protected COSName

BaseParser.parseCOSName() This will parse a PDF name from the stream.

Uses of COSName in org.apache.pdfbox.pdfviewer

Methods in org.apache.pdfbox.pdfviewer with parameters of type COSName

void	PageDrawer.SHFill(COSName ShadingName) Fill with Shading.

Uses of COSName in org.apache.pdfbox.pdfwriter

Methods in org.apache.pdfbox.pdfwriter with parameters of type COSName

Object

COSWriter.visitFromName(COSName obj) visitFromName method comment.

Uses of COSName in org.apache.pdfbox.pdmodel.common

Methods in org.apache.pdfbox.pdmodel.common with parameters of type COSName

COSBase	COSStreamArray.getDictionaryObject(COSName key) This will get an object from this streams dictionary and dereference it if necessary.
COSBase	COSStreamArray.getItem(COSName key) This will get an object from this streams dictionary.

Constructors in org.apache.pdfbox.pdmodel.common with parameters of type COSName

COSArrayList(Object actualObject, COSBase item, COSDictionary dictionary, COSName dictionaryKey)
This is a really special constructor.

PDNamedTextStream(COSName name, COSBase str)
Constructor.

Uses of COSName in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent

Methods in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent with parameters of type COSName

static PDMarkedContent

PDMarkedContent.create(COSName tag, COSDictionary properties) Creates a marked-content sequence.

Constructors in org.apache.pdfbox.pdmodel.documentinterchange.markedcontent with parameters of type COSName

PDMarkedContent(COSName tag, COSDictionary properties)
Creates a new marked content object.

Uses of COSName in org.apache.pdfbox.pdmodel.encryption

Methods in org.apache.pdfbox.pdmodel.encryption that return COSName

COSName	PDCryptFilterDictionary.getCryptFilterMethod() This will return the crypt filter method.
COSName	PDEncryptionDictionary.getStreamFilterName() Returns the name of the filter which is used for de/encrypting streams.
COSName	PDEncryptionDictionary.getStringFilterName() Returns the name of the filter which is used for de/encrypting strings.

Methods in org.apache.pdfbox.pdmodel.encryption with parameters of type COSName

PDCryptFilterDictionary	PDEncryptionDictionary.getCryptFilterDictionary(COSName cryptFilterName) Returns the crypt filter with the given name.
void	PDCryptFilterDictionary.setCryptFilterMethod(COSName cfm) This will set the crypt filter method.

Uses of COSName in org.apache.pdfbox.pdmodel.graphics

Methods in org.apache.pdfbox.pdmodel.graphics that return COSName

COSName

PDShading.getShadingName() This will return the name of this particular shading dictionary

Constructors in org.apache.pdfbox.pdmodel.graphics with parameters of type COSName

PDShading(COSName name, COSDictionary shading)
Constructor.

Uses of COSName in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination

Constructors in org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination with parameters of type COSName

PDNamedDestination(COSName dest)
Constructor.

Uses of COSName in org.apache.pdfbox.util

Methods in org.apache.pdfbox.util with parameters of type COSName

void	PDFMarkedContentExtractor.beginMarkedContentSequence(COSName tag, COSDictionary properties)