Class PdfName
- All Implemented Interfaces:
Comparable<PdfName>
PdfName
is an object that can be used as a name in a PDF-file.
A name, like a string, is a sequence of characters. It must begin with a slash followed by a sequence of ASCII
characters in the range 32 through 136 except %, (, ), [, ], <, >, {, }, / and #. Any character except 0x00 may
be included in a name by writing its two character hex code, preceded by #. The maximum number of characters in a
name is 127.
This object is described in the 'Portable Document Format Reference Manual version 1.7' section
3.2.4 (page 56-58).
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PdfName
A name.static final PdfName
(Optional) An action that shall be performed when the annotation is activated.static final PdfName
(Optional) An additional-actions dictionary defining the field's / annotations's behaviour in response to various trigger events.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required) A name which, in conjunction with Fields, indicates the set of fields that should be locked.static final PdfName
A name.static final PdfName
a name used in PDF structurestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(PDF 1.6; deprecated) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with 7.6.3.1, "Algorithm 1: Encryption of data using the RC4or AES algorithms", using the AES algorithm in Cipher BlockChaining (CBC) mode with a 16-byte block size and an initialization vector that shall be randomly generated and placed as the first 16 bytes in the stream or string.static final PdfName
(PDF 2.0) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with 7.6.3.2, "Algorithm 1.A: Encryption of data using the AES algorithms", using the AES-256 algorithm in Cipher Block Chaining (CBC)with padding mode with a 16-byte block size and an initialization vector that is randomly generated and placed as the first 16 bytes in the stream or string.static final PdfName
(Optional; PDF 2.0) An array of one or more file specification dictionaries which denote the associated files for this annotation.static final PdfName
A namestatic final PdfName
Stands for "Lock all fields in the document" which is one possible value of the Action attribute in a signature field lock dictionarystatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) An appearance dictionary specifying how the annotation shall be presented visually on the page.static final PdfName
A build data dictionary for a description of the signature APP.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required if the appearance dictionary AP contains one or more subdictionaries) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; PDF 2.0) The blend mode that shall be used when painting the annotation onto the page.static final PdfName
Optional) An array specifying the characteristics of the annotation's border, which shall be drawn as a rounded rectangle.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
An array of pairs of integers (starting byte offset, length in bytes) describing the exact byte range for the digest calculation.static final PdfName
(Optional) An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes: The background of the annotation's icon when closed The title bar of the annotation's popup window The border of a link annotationstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; PDF 2.0) When regenerating the annotation's appearance stream, this is the opacity value that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened.static final PdfName
(Optional; PDF 2.0) When regenerating the annotation's appearance stream, this is the opacity value that shall be used for stroking all visiblea elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
An array of indirect reference to streams, each containing one DER-encoded X.509 certificate (see RFC 5280).static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
Used in several places: 1) Annotations: (Optional) Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation's contents in human-readable form.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
An array of indirect references to streams, each containing a DER-encoded Certificate Revocation List (CRL) (see RFC 5280).static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
(Required; inheritable) The default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and colour.static final PdfName
A namestatic final PdfName
Part of the Build Data Dictionary.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) A default style string; described in the PDF Annex M.static final PdfName
A DSS dictionary containing document-wide security information.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed.static final PdfName
A namestatic final PdfName
Entry in a structure element dictionary: The expanded form of an abbreviation or an acronym.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Extension supplied by ETSI TS 102 778-4 V1.1.2 (2009-12)static final PdfName
A namestatic final PdfName
Stands for "Exclude all fields except those specified in Fields array" which is one possible value of the Action attribute in a signature field lock dictionarystatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) A set of flags specifying various characteristics of the annotation Default value: 0.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; inheritable) A set of flags specifying various characteristics of the field.static final PdfName
A namestatic final PdfName
The FieldMDP transform method shall be used to detect changes to the values of a list of form fields.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A byte string specifying the preferred font family name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required) The PostScript name of the font.static final PdfName
(Optional); PDF 1.5; The weight (thickness) component of the fully-qualified font name or font specifier.static final PdfName
A namestatic final PdfName
A nameList of names used in form field dictionariesstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
The type of field that this dictionary describes: Btn Button, Tx Text, Ch Choice, Sig Signature (Required; inheritable)static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
Optional) The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area: N (None) No highlighting.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.private int
static final PdfName
A name of an attribute.static final PdfName
A namestatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
(Sometimes required, otherwise optional) For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Stands for "Include all fields specified in Fields array" which is one possible value of the Action attribute in a signature field lock dictionarystatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Sometimes required, as described) An array of indirect references to the immediate children of this field.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; PDF 2.0) A language identifier overriding the document's language identifier to specify the natural language for all text in the annotation except where overridden by other explicit language specifications.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; shall be an indirect reference) A signature field lock dictionary that specifies a set of form fields that shall be locked when this signature field is signed.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) The date and time when the annotation was most recently modified.static final PdfName
A name of an encodingstatic final PdfName
A name of an encodingstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; inheritable) The maximum length of the field's text, in charactersstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) An appearance characteristics dictionary that shall be used in constructing a dynamic appearance stream specifying the annotation's visual presentation on the page.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(optional) The name of the person or authority signing the document.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
The annotation name, a text string uniquely identifying it among all the annotations on its page.static final PdfName
A namestatic final PdfName
If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed)static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name used with Document Structurestatic final PdfName
a name used with Doucment Structurestatic final PdfName
A namestatic final PdfName
(Optional) An optional content group or optional content membership dictionary specifying the optional content properties for the annotation.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
An array of indirect references to streams, each containing a DER-encoded Online Certificate Status Protocol (OCSP) response (see RFC 6960).static final PdfName
(Required if R is 6 (PDF 2.0)) A 32-byte string, based on the owner and userpassword, that shall be used in computing the file encryption key.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; inheritable) An array containing one entry for each widget annotation in the Kids array of the radio button or check box field.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
Parts of the Build Data Dictionary.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) An indirect reference to the page object with which this annotation is associated.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required if this field is the child of another in the field hierarchy; absent otherwise) The field that is the immediate parent of this one (the field, if any, whose Kids array includes this field).static final PdfName
A namestatic final PdfName
A name used in defining Document Structure.static final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A name.static final PdfName
(Required; barcode fields only; ExtensionLevel 3) The PaperMetaData generation parameters dictionary.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
Parts of the Build Data Dictionary.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
The build properties dictionary and all of its contents are required to be direct objects.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
(Optional; inheritable) A code specifying the form of quadding (justification) that shall be used in displaying the text: 0 Left-justified (default) 1 Centered 2 Right-justifiedstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Part of the Build Data Dictionary.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required) The annotation rectangle, defining the location of the annotation on the page in default user space units.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Part of the Build Data Dictionary when used as the App dictionary.static final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) A rich text string; described in the PDF Specification Annex Mstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
The type name of a signature field lock dictionarystatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; PDF 1.5) The state to which the original annotation should be set.static final PdfName
(Required if State is present, otherwise optional; PDF 1.5) The state model corresponding to State; see "Annotation States" above.map strings to all known static namesstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required if the annotation is a structural content item) The integer key of the annotation's entry in the structural parent tree.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Required) The type of annotation that this dictionary describes.static final PdfName
A namestatic final PdfName
(Optional; shall be an indirect reference) A seed value dictionary containing information that constrains the properties of a signature that is applied to this field.static final PdfName
A namestatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
(Required; ExtensionLevel 3) Specifies which barcode or glyph technology is to be used on this annotation.static final PdfName
(Required) The partial field name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list).static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Optional) The mapping name that shall be used when exporting interactive form field data from the document.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
Parts of the Build Data Dictionary If the value is true, the application was in trusted mode when signing took place.static final PdfName
(Optional) An alternative field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field).static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
There are lots of Type s in the PDF specification.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
(Required if R=6 (PDF 2.0)) A 32-byte string, based on the user password, that shall be used in computing the file encryption key.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional; inheritable) The field value, whose format varies depending on the field type.static final PdfName
(Deprecated) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with7.6.3.1, "Algorithm 1: Encryption of data using the RC4 or AESalgorithms", using the RC4 algorithm.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name.static final PdfName
This dictionary contains Signature VRI dictionaries (see PDF 2.0 ch.static final PdfName
A name of an attribute.static final PdfName
A name of an attribute.static final PdfName
A namestatic final PdfName
A name of an attribute.static final PdfName
A namestatic final PdfName
A name of an attribute.List of names used for widget annotationsstatic final PdfName
A name of an attribute.static final PdfName
A namestatic final PdfName
A name of an encodingstatic final PdfName
A name of an encodingstatic final PdfName
A name.static final PdfName
A name.static final PdfName
A name of an encodingstatic final PdfName
A namestatic final PdfName
A name of an encodingstatic final PdfName
A namestatic final PdfName
A name.static final PdfName
A name.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
A namestatic final PdfName
(Optional) The checked value for the Checkbox form field.static final PdfName
A namestatic final PdfName
A namestatic final PdfName
A name of a base 14 type 1 fontstatic final PdfName
A nameFields inherited from class com.lowagie.text.pdf.PdfObject
ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, indRef, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Compares this object with the specified object for order.static String
decodeName
(String name) Decodes an escaped name given in the form "/AB#20CD" into "AB CD".static byte[]
encodeName
(String name) Encodes a plain name given in the unescaped form "AB CD" into "/AB#20CD".boolean
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.private static void
Methods inherited from class com.lowagie.text.pdf.PdfObject
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, toPdf, toString, type
-
Field Details
-
_3D
A name.- Since:
- 2.1.6
-
A
(Optional) An action that shall be performed when the annotation is activated. -
AA
(Optional) An additional-actions dictionary defining the field's / annotations's behaviour in response to various trigger events. This entry has exactly the same meaning as the AA entry in an annotation dictionary. -
ABSOLUTECOLORIMETRIC
A name- Since:
- 2.1.5 renamed from ABSOLUTECALORIMETRIC
-
AC
A name -
ACROFORM
A name -
ACTION
(Required) A name which, in conjunction with Fields, indicates the set of fields that should be locked. The value shall be one of the following: All, include or exclude. -
ACTIVATION
A name.- Since:
- 2.1.6
-
ADBE
A name.- Since:
- 2.1.6
-
ACTUALTEXT
a name used in PDF structure- Since:
- 2.1.6
-
ADBE_PKCS7_DETACHED
A name -
ADBE_PKCS7_S4
A name -
ADBE_PKCS7_S5
A name -
ADBE_PKCS7_SHA1
A name -
ADBE_X509_RSA_SHA1
A name -
ADOBE_PPKLITE
A name -
ADOBE_PPKMS
A name -
AESV2
(PDF 1.6; deprecated) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with 7.6.3.1, "Algorithm 1: Encryption of data using the RC4or AES algorithms", using the AES algorithm in Cipher BlockChaining (CBC) mode with a 16-byte block size and an initialization vector that shall be randomly generated and placed as the first 16 bytes in the stream or string. The key size(Length) shall be 128 bits. -
AESV3
(PDF 2.0) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with 7.6.3.2, "Algorithm 1.A: Encryption of data using the AES algorithms", using the AES-256 algorithm in Cipher Block Chaining (CBC)with padding mode with a 16-byte block size and an initialization vector that is randomly generated and placed as the first 16 bytes in the stream or string. The key size (Length)shall be 256 bits. -
AF
(Optional; PDF 2.0) An array of one or more file specification dictionaries which denote the associated files for this annotation. -
AIS
A name -
ALL
Stands for "Lock all fields in the document" which is one possible value of the Action attribute in a signature field lock dictionary -
ALLPAGES
A name -
ALT
A name -
ALTERNATE
A name -
ANIMATION
A name.- Since:
- 2.1.6
-
ANNOT
A name -
ANNOTS
A name -
ANTIALIAS
A name -
AP
(Optional) An appearance dictionary specifying how the annotation shall be presented visually on the page. A PDF writer shall include an appearance dictionary when writing or updating an annotation dictionary except for the two cases listed below. Every annotation (including those whose Subtype value is Widget, as used for form fields), except for the two cases listed below, shall have at least one appearance dictionary. Exclusions:- Annotations where the value of the Rect key consists of an array where the value at index 1 is equal to the value at index 3 or the value at index 2 is equal to the value at index 4
- Annotations whose Subtype value is Popup, Projection or Link.
-
APP
A build data dictionary for a description of the signature APP. -
APPDEFAULT
A name -
ART
A name- Since:
- 2.1.6
-
ARTBOX
A name -
ASCENT
A name -
AS
(Required if the appearance dictionary AP contains one or more subdictionaries) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary. -
ASCII85DECODE
A name -
ASCIIHEXDECODE
A name -
ASSET
A name.- Since:
- 2.1.6
-
ASSETS
A name.- Since:
- 2.1.6
-
AUTHEVENT
A name -
AUTHOR
A name -
B
A name -
BACKGROUND
A name- Since:
- 2.1.6
-
BASEENCODING
A name -
BASEFONT
A name -
BASEVERSION
A name- Since:
- 2.1.6
-
BBOX
A name -
BC
A name -
BG
A name -
BIBENTRY
A name- Since:
- 2.1.6
-
BIGFIVE
A name -
BINDING
A name.- Since:
- 2.1.6
-
BINDINGMATERIALNAME
A name.- Since:
- 2.1.6
-
BITSPERCOMPONENT
A name -
BITSPERSAMPLE
A name -
BL
A name -
BLACKIS1
A name -
BLACKPOINT
A name -
BLOCKQUOTE
A name- Since:
- 2.1.6
-
BLEEDBOX
A name -
BLINDS
A name -
BM
(Optional; PDF 2.0) The blend mode that shall be used when painting the annotation onto the page. If this key is not present, blending shall take place using the Normal blend mode. The value shall be a name object, designating one of the standard blend modes. -
BORDER
Optional) An array specifying the characteristics of the annotation's border, which shall be drawn as a rounded rectangle. -
BOUNDS
A name -
BOX
A name -
BS
A name -
BTN
A name -
BYTERANGE
An array of pairs of integers (starting byte offset, length in bytes) describing the exact byte range for the digest calculation. (Required) -
C
(Optional) An array of numbers in the range 0.0 to 1.0, representing a colour used for the following purposes:- The background of the annotation's icon when closed
- The title bar of the annotation's popup window
- The border of a link annotation
The number of array elements determines the colour space in which the colour shall be defined: 0=No colour; transparent 1=DeviceGray 3=DeviceRGB 4=DeviceCMYK
-
C0
A name -
C1
A name -
CA
(Optional; PDF 2.0) When regenerating the annotation's appearance stream, this is the opacity value that shall be used for stroking all visiblea elements of the annotation in its closed state, including its background and border, but not the popup window that appears when the annotation is opened. If a ca entry is not present in this dictionary, then the value of this CA entry shall also be used for nonstroking operations as well.Default Value: 1.0
The specified value shall not be used if the annotation has an appearance stream; in that case, the appearance stream shall specify any transparency.
-
ca
(Optional; PDF 2.0) When regenerating the annotation's appearance stream, this is the opacity value that shall be used for all nonstroking operations on all visible elements of the annotation in its closed state (including its background and border) but not the popup window that appears when the annotation is opened. Default value: 1.0 The specified value shall not be used if the annotation has an appearance stream in that case, the appearance stream shall specify any transparency. -
CALGRAY
A name -
CALRGB
A name -
CAPHEIGHT
A name -
CAPTION
A name- Since:
- 2.1.6
-
CATALOG
A name -
CATEGORY
A name -
CCITTFAXDECODE
A name -
CENTER
A name.- Since:
- 2.1.6
-
CENTERWINDOW
A name -
CERT
A name -
CERTS
An array of indirect reference to streams, each containing one DER-encoded X.509 certificate (see RFC 5280). This array contains certificates that maybe used in the validation of any signatures in the document. -
CF
A name -
CFM
A name -
CH
A name -
CHARPROCS
A name -
CHECKSUM
A name -
CI
A name -
CIDFONTTYPE0
A name -
CIDFONTTYPE2
A name -
CIDSET
A name- Since:
- 2.0.7
-
CIDSYSTEMINFO
A name -
CIDTOGIDMAP
A name -
CIRCLE
A name -
CMD
A name.- Since:
- 2.1.6
-
CO
A name -
CODE
A name- Since:
- 2.1.6
-
COLORS
A name -
COLORSPACE
A name -
COLLECTION
A name -
COLLECTIONFIELD
A name -
COLLECTIONITEM
A name -
COLLECTIONSCHEMA
A name -
COLLECTIONSORT
A name -
COLLECTIONSUBITEM
A name -
COLUMNS
A name -
CONDITION
A name.- Since:
- 2.1.6
-
CONFIGURATION
A name.- Since:
- 2.1.6
-
CONFIGURATIONS
A name.- Since:
- 2.1.6
-
CONTACTINFO
A name -
CONTENT
A name -
CONTENTS
Used in several places:- 1) Annotations: (Optional) Text that shall be displayed for the annotation or, if this type of annotation does not display text, an alternative description of the annotation's contents in human-readable form. In either case, this text is useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes. Might be different for each annotation type.
- 2) Part of the signature dictionary. The signature value. The value is a hexadecimal string representing the value of the byte range digest. (Required)
-
COORDS
A name -
COUNT
A name -
COURIER
A name of a base 14 type 1 font -
COURIER_BOLD
A name of a base 14 type 1 font -
COURIER_OBLIQUE
A name of a base 14 type 1 font -
COURIER_BOLDOBLIQUE
A name of a base 14 type 1 font -
CREATIONDATE
A name -
CREATOR
A name -
CREATORINFO
A name -
CRLS
An array of indirect references to streams, each containing a DER-encoded Certificate Revocation List (CRL) (see RFC 5280). This array contains CRLs that may be used in the validation of the signatures in the document. -
CROPBOX
A name -
CRYPT
A name -
CS
A name -
CUEPOINT
A name.- Since:
- 2.1.6
-
CUEPOINTS
A name.- Since:
- 2.1.6
-
D
A name -
DA
(Required; inheritable) The default appearance string containing a sequence of valid page-content graphics or text state operators that define such properties as the field's text size and colour. -
DATA
A name -
DATE
Part of the Build Data Dictionary. The software module build date. -
DC
A name -
DCTDECODE
A name -
DEACTIVATION
A name.- Since:
- 2.1.6
-
DECODE
A name -
DECODEPARMS
A name -
DEFAULT
A name- Since:
- 2.1.6
-
DEFAULTCRYPTFILTER
A name- Since:
- 2.1.5 renamed from DEFAULTCRYPTFILER
-
DEFAULTCMYK
A name -
DEFAULTGRAY
A name -
DEFAULTRGB
A name -
DESC
A name -
DESCENDANTFONTS
A name -
DESCENT
A name -
DEST
A name -
DESTOUTPUTPROFILE
A name -
DESTS
A name -
DEVICEGRAY
A name -
DEVICERGB
A name -
DEVICECMYK
A name -
DI
A name -
DIFFERENCES
A name -
DISSOLVE
A name -
DIRECTION
A name -
DISPLAYDOCTITLE
A name -
DIV
A name -
DL
A name -
DM
A name -
DOCMDP
A name -
DOCOPEN
A name -
DOCUMENT
A name.- Since:
- 2.1.6
-
DOMAIN
A name -
DP
A name -
DR
A name -
DS
(Optional) A default style string; described in the PDF Annex M. -
DSS
A DSS dictionary containing document-wide security information. See PDF 2.0 specification ch. 12.8.4.3 for further details. -
DUR
A name -
DUPLEX
A name -
DUPLEXFLIPSHORTEDGE
A name -
DUPLEXFLIPLONGEDGE
A name -
DV
(Optional; inheritable) The default value to which the field reverts when a reset-form action is executed. The format of this value is the same as that of V. -
DW
A name -
E
Entry in a structure element dictionary: The expanded form of an abbreviation or an acronym.OR
Entry in an annotation’s additional-actions dictionary: An action that shall be performed when the cursor enters theannotation’s active area.
OR
Entry in a collection field dictionary: A flag indicating whether the interactive PDF processor should provide support for editing the field value.
OR more...
-
EARLYCHANGE
A name -
EF
A name -
EFF
A name- Since:
- 2.1.3
-
EFOPEN
A name- Since:
- 2.1.3
-
EMBEDDED
A name- Since:
- 2.1.6
-
EMBEDDEDFILE
A name -
EMBEDDEDFILES
A name -
ENCODE
A name -
ENCODEDBYTEALIGN
A name -
ENCODING
A name -
ENCRYPT
A name -
ENCRYPTMETADATA
A name -
ENDOFBLOCK
A name -
ENDOFLINE
A name -
ESIC
Extension supplied by ETSI TS 102 778-4 V1.1.2 (2009-12) -
EXCLUDE
Stands for "Exclude all fields except those specified in Fields array" which is one possible value of the Action attribute in a signature field lock dictionary -
EXTEND
A name -
EXTENSIONS
A name- Since:
- 2.1.6
-
EXTENSIONLEVEL
A name- Since:
- 2.1.6
-
EXTGSTATE
A name -
EXPORT
A name -
EXPORTSTATE
A name -
EVENT
A name -
F
(Optional) A set of flags specifying various characteristics of the annotation Default value: 0. -
FAR
A name.- Since:
- 2.1.6
-
FB
A name -
FDECODEPARMS
A name -
FDF
A name -
FF
(Optional; inheritable) A set of flags specifying various characteristics of the field. Default value: 0. -
FFILTER
A name -
FIELDMDP
The FieldMDP transform method shall be used to detect changes to the values of a list of form fields. The entries in its transform parameters dictionary are Type, Actions, Field and V. -
FIELDS
A name -
FIGURE
A name- Since:
- 2.1.6
-
FILEATTACHMENT
A name -
FILEID
A name -
FILESPEC
A name -
FILTER
A name -
FIRST
A name -
FIRSTCHAR
A name -
FIRSTPAGE
A name -
FIT
A name -
FITH
A name -
FITV
A name -
FITR
A name -
FITB
A name -
FITBH
A name -
FITBV
A name -
FITWINDOW
A name -
FLAGS
A name -
FLASH
A name.- Since:
- 2.1.6
-
FLASHVARS
A name.- Since:
- 2.1.6
-
FLATEDECODE
A name -
FO
A name -
FONT
A name -
FONTBBOX
A name -
FONTDESCRIPTOR
A name -
FONTFAMILY
A byte string specifying the preferred font family name. E.g. for the font Times Bold Italic, the FontFamily is Times. -
FONTFILE
A name -
FONTFILE2
A name -
FONTFILE3
A name -
FONTMATRIX
A name -
FONTNAME
(Required) The PostScript name of the font. This name shall be the same as the value of BaseFont in the font or CIDFont dictionary that refers to this font descriptor. -
FONTWEIGHT
(Optional); PDF 1.5; The weight (thickness) component of the fully-qualified font name or font specifier. The possible values shall be 100, 200, 300, 400, 500, 600, 700, 800, or 900, where each number indicates a weight that is at least as dark as its predecessor. A value of 400 shall indicate a normal weight; 700 shall indicate bold. The specific interpretation of these values varies from font to font. E.g. 300 in one font may appear most similar to 500 in another. -
FOREGROUND
A name- Since:
- 2.1.6
-
FORM
A name -
FORMTYPE
A name -
FORMULA
A name- Since:
- 2.1.6
-
FREETEXT
A name -
FRM
A name -
FS
A name -
FT
The type of field that this dictionary describes: Btn Button, Tx Text, Ch Choice, Sig Signature (Required; inheritable) -
FULLSCREEN
A name -
FUNCTION
A name -
FUNCTIONS
A name -
FUNCTIONTYPE
A name -
GAMMA
A name of an attribute. -
GBK
A name of an attribute. -
GLITTER
A name of an attribute. -
GOTO
A name of an attribute. -
GOTOE
A name of an attribute. -
GOTOR
A name of an attribute. -
GROUP
A name of an attribute. -
GTS_PDFA1
A name of an attribute. -
GTS_PDFX
A name of an attribute. -
GTS_PDFXVERSION
A name of an attribute. -
H
Optional) The annotation's highlighting mode, the visual effect that shall be used when the mouse button is pressed or held down inside its active area:- N (None) No highlighting.
- I (Invert) Invert the colours used to display the contents of the annotation rectangle.
- O (Outline) Stroke the colours used to display the annotation border.
- P (Push) Display the annotation's down appearance, if any. If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were beingpushed below the surface of the page.
- T (Toggle) Same as P (which is preferred).
-
H1
A name- Since:
- 2.1.6
-
H2
A name- Since:
- 2.1.6
-
H3
A name- Since:
- 2.1.6
-
H4
A name- Since:
- 2.1.6
-
H5
A name- Since:
- 2.1.6
-
H6
A name- Since:
- 2.1.6
-
HALIGN
A name.- Since:
- 2.1.6
-
HEIGHT
A name of an attribute. -
HELV
A name -
HELVETICA
A name of a base 14 type 1 font -
HELVETICA_BOLD
A name of a base 14 type 1 font -
HELVETICA_OBLIQUE
A name of a base 14 type 1 font -
HELVETICA_BOLDOBLIQUE
A name of a base 14 type 1 font -
HID
A name -
HIDE
A name -
HIDEMENUBAR
A name -
HIDETOOLBAR
A name -
HIDEWINDOWUI
A name -
HIGHLIGHT
A name -
HOFFSET
A name.- Since:
- 2.1.6
-
I
(Sometimes required, otherwise optional) For choice fields that allow multiple selection (MultiSelect flag set), an array of integers, sorted in ascending order, representing the zero-based indices in the Opt array of the currently selected option items. This entry shall be used when two or more elements in the Opt array have different names but the same export value or when the value of the choice field is an array. If the items identified by this entry differ from those in the V entry of the field dictionary (see discussion following this Table), the V entry shall be used. -
ICCBASED
A name -
ID
A name -
IDENTITY
A name -
IF
A name -
IMAGE
A name -
IMAGEB
A name -
IMAGEC
A name -
IMAGEI
A name -
IMAGEMASK
A name -
INCLUDE
Stands for "Include all fields specified in Fields array" which is one possible value of the Action attribute in a signature field lock dictionary -
INDEX
A name -
INDEXED
A name -
INFO
A name -
INK
A name -
INKLIST
A name -
INSTANCES
A name.- Since:
- 2.1.6
-
IMPORTDATA
A name -
INTENT
A name -
INTERPOLATE
A name -
ISMAP
A name -
IRT
A name -
ITALICANGLE
A name -
IX
A name -
JAVASCRIPT
A name -
JBIG2DECODE
A name- Since:
- 2.1.5
-
JBIG2GLOBALS
A name- Since:
- 2.1.5
-
JPXDECODE
A name -
JS
A name -
K
A name -
KEYWORDS
A name -
KIDS
(Sometimes required, as described) An array of indirect references to the immediate children of this field. In a non-terminal field, the Kids array shall refer to field dictionaries that are immediate descendants of this field. In a terminal field, the Kids array ordinarily shall refer to one or more separate widget annotations that are associated with this field. However, if there is only one associated widget annotation, and its contents have been merged into the field dictionary, Kids shall be omitted. -
L
A name -
L2R
A name -
LANG
(Optional; PDF 2.0) A language identifier overriding the document's language identifier to specify the natural language for all text in the annotation except where overridden by other explicit language specifications. -
LANGUAGE
A name -
LAST
A name -
LASTCHAR
A name -
LASTPAGE
A name -
LAUNCH
A name -
LBL
A name- Since:
- 2.1.6
-
LBODY
A name- Since:
- 2.1.6
-
LENGTH
A name -
LENGTH1
A name -
LI
A name- Since:
- 2.1.6
-
LIMITS
A name -
LINE
A name -
LINEAR
A name.- Since:
- 2.1.6
-
LINK
A name -
LISTMODE
A name -
LOCATION
A name -
LOCK
(Optional; shall be an indirect reference) A signature field lock dictionary that specifies a set of form fields that shall be locked when this signature field is signed. -
LOCKED
A name- Since:
- 2.1.2
-
LZWDECODE
A name -
M
(Optional) The date and time when the annotation was most recently modified. The format should be a date string (a text string containing no whitespace, of the form (D:YYYYMMDDHHmmSSOHH'mm)) but interactive PDF processors shall accept and display a string in any format. -
MATERIAL
A name- Since:
- 2.1.6
-
MATRIX
A name -
MAC_EXPERT_ENCODING
A name of an encoding -
MAC_ROMAN_ENCODING
A name of an encoding -
MARKED
A name -
MARKINFO
A name -
MASK
A name -
MAX_LOWER_CASE
A name- Since:
- 2.1.6 renamed from MAX
-
MAX_CAMEL_CASE
A name- Since:
- 2.1.6
-
MAXLEN
(Optional; inheritable) The maximum length of the field's text, in characters -
MEDIABOX
A name -
MCID
A name -
MCR
A name -
METADATA
A name -
MIN_LOWER_CASE
A name- Since:
- 2.1.6 renamed from MIN
-
MIN_CAMEL_CASE
A name- Since:
- 2.1.6
-
MK
(Optional) An appearance characteristics dictionary that shall be used in constructing a dynamic appearance stream specifying the annotation's visual presentation on the page. -
MMTYPE1
A name -
MODDATE
A name -
N
A name -
N0
A name -
N1
A name -
N2
A name -
N3
A name -
N4
A name -
NAME
(optional) The name of the person or authority signing the document. This value should be used only when it is not possible to extract the name from the signature. -
NAMED
A name -
NAMES
A name -
NAVIGATION
A name.- Since:
- 2.1.6
-
NAVIGATIONPANE
A name.- Since:
- 2.1.6
-
NEAR
A name.- Since:
- 2.1.6
-
NEEDAPPEARANCES
A name -
NEWWINDOW
A name -
NEXT
A name -
NEXTPAGE
A name -
NM
The annotation name, a text string uniquely identifying it among all the annotations on its page. -
NONE
A name -
NONEFONTNOWARN
If there is a Legal dictionary in the catalog of the PDF file, and the NonEmbeddedFonts attribute (which specifies the number of fonts not embedded) in that dictionary has a non-zero value, and the viewing application has a preference set to suppress the display of the warning about fonts not being embedded, then the value of this attribute will be set to true (meaning that no warning need be displayed) -
NONFULLSCREENPAGEMODE
A name -
NONSTRUCT
A name- Since:
- 2.1.6
-
NOTE
A name- Since:
- 2.1.6
-
NUMCOPIES
A name -
NUMS
A name -
O
A name -
OBJ
A name used with Document Structure- Since:
- 2.1.5
-
OBJR
a name used with Doucment Structure- Since:
- 2.1.5
-
OBJSTM
A name -
OC
(Optional) An optional content group or optional content membership dictionary specifying the optional content properties for the annotation. Before the annotation is drawn, its visibility shall be determined based on this entry as well as the annotation flags specified in the F entry. If it is determined to be invisible, the annotation shall not be drawn. -
OCG
A name -
OCGS
A name -
OCMD
A name -
OCPROPERTIES
A name -
YES
(Optional) The checked value for the Checkbox form field. The recommended name for the on state is Yes, but this is not required. -
OCSPS
An array of indirect references to streams, each containing a DER-encoded Online Certificate Status Protocol (OCSP) response (see RFC 6960). This array contains OCSPs that may be used in the validation of the signatures in the document. -
OE
(Required if R is 6 (PDF 2.0)) A 32-byte string, based on the owner and userpassword, that shall be used in computing the file encryption key. -
Off
A name -
OFF
A name -
ON
A name -
ONECOLUMN
A name -
OPEN
A name -
OPENACTION
A name -
OP
A name -
op
A name -
OPM
A name -
OPT
(Optional; inheritable) An array containing one entry for each widget annotation in the Kids array of the radio button or check box field. Each entry shall be a text string representing the on state of the corresponding widget annotation. When this entry is present, the names used to represent the on state in the AP dictionary of each annotation may use numerical position (starting with 0) of the annotation in the Kids array, encoded as a name object (for example: /0, /1). This allows distinguishing between the annotations even if two or more of them have the same value in the Opt array. -
ORDER
A name -
ORDERING
A name -
OS
Parts of the Build Data Dictionary. Indicates the operating system, such as Win10. Currently there is no specific string format defined for the value of this attribute. -
OSCILLATING
A name.- Since:
- 2.1.6
-
OUTLINES
A name -
OUTPUTCONDITION
A name -
OUTPUTCONDITIONIDENTIFIER
A name -
OUTPUTINTENT
A name -
OUTPUTINTENTS
A name -
P
(Optional) An indirect reference to the page object with which this annotation is associated. This entry shall be present in screen annotations associated with rendition actions. OR (Optional; PDF 2.0) The access permissions granted for this document. Valid values shall be 1,2,3 -
PAGE
A name -
PAGELABELS
A name -
PAGELAYOUT
A name -
PAGEMODE
A name -
PAGES
A name -
PAINTTYPE
A name -
PANOSE
A name -
PARAMS
A name -
PARENT
(Required if this field is the child of another in the field hierarchy; absent otherwise) The field that is the immediate parent of this one (the field, if any, whose Kids array includes this field). A field can have at most one parent; that is, it can be included in the Kids array of at most one other field. -
PARENTTREE
A name -
PARENTTREENEXTKEY
A name used in defining Document Structure.- Since:
- 2.1.5
-
PART
A name- Since:
- 2.1.6
-
PASSCONTEXTCLICK
A name.- Since:
- 2.1.6
-
PATTERN
A name -
PATTERNTYPE
A name -
PC
A name.- Since:
- 2.1.6
-
PDF
A name -
PDFDOCENCODING
A name -
PERCEPTUAL
A name -
PERMS
A name -
PG
A name -
PI
A name.- Since:
- 2.1.6
-
PICKTRAYBYPDFSIZE
A name -
PLAYCOUNT
A name.- Since:
- 2.1.6
-
PMD
(Required; barcode fields only; ExtensionLevel 3) The PaperMetaData generation parameters dictionary. The entries of this dictionary are instructions to the barcode encoding software on how to generate the barcode image. (Part of *dobe Supplement to the ISO 32000) -
PO
A name.- Since:
- 2.1.6
-
POPUP
A name -
POSITION
A name.- Since:
- 2.1.6
-
PREDICTOR
A name -
PREFERRED
A name -
PRERELEASE
Parts of the Build Data Dictionary. A flag that can be used by the signature handler or software module to indicate that this signature was created with unreleased software. -
PRESENTATION
A name.- Since:
- 2.1.6
-
PRESERVERB
A name -
PREV
A name -
PREVPAGE
A name -
PRINT
A name -
PRINTAREA
A name -
PRINTCLIP
A name -
PRINTPAGERANGE
A name -
PRINTSCALING
A name -
PRINTSTATE
A name -
PRIVATE
A name- Since:
- 2.1.6
-
PROCSET
A name -
PRODUCER
A name -
PROP_BUILD
The build properties dictionary and all of its contents are required to be direct objects. The use of a build properties dictionary is optional but highly recommended. The build properties dictionary may contain a build data dictionary entry for each unique software module used to create the signature. The software modules involved in the signing process will vary depending on the viewing application. All signing implementations should include at least a Filter entry in the build properties dictionary. -
PROPERTIES
A name -
PS
A name -
PUBSEC
A name -
PV
A name.- Since:
- 2.1.6
-
Q
(Optional; inheritable) A code specifying the form of quadding (justification) that shall be used in displaying the text:- 0 Left-justified (default)
- 1 Centered
- 2 Right-justified
-
QUADPOINTS
A name -
QUOTE
A name- Since:
- 2.1.6
-
R
Part of the Build Data Dictionary. The software module revision number -
R2L
A name -
RANGE
A name -
RC
A name -
RBGROUPS
A name -
REASON
A name -
RECIPIENTS
A name -
RECT
(Required) The annotation rectangle, defining the location of the annotation on the page in default user space units. -
REFERENCE
A name -
REGISTRY
A name -
REGISTRYNAME
A name -
RELATIVECOLORIMETRIC
A name- Since:
- 2.1.5 renamed from RELATIVECALORIMETRIC
-
RENDITION
A name -
RESETFORM
A name -
RESOURCES
A name -
RI
A name -
REX
Part of the Build Data Dictionary when used as the App dictionary. A text string indicating the version of the application implementation, as described by the Name attribute in this dictionary. When set by Adobe Acrobat, this entry is in the format: major.minor.micro (for example 7.0.7). -
RICHMEDIA
A name.- Since:
- 2.1.6
-
RICHMEDIAACTIVATION
A name.- Since:
- 2.1.6
-
RICHMEDIAANIMATION
A name.- Since:
- 2.1.6
-
RICHMEDIACOMMAND
A name- Since:
- 2.1.6
-
RICHMEDIACONFIGURATION
A name.- Since:
- 2.1.6
-
RICHMEDIACONTENT
A name.- Since:
- 2.1.6
-
RICHMEDIADEACTIVATION
A name.- Since:
- 2.1.6
-
RICHMEDIAEXECUTE
A name.- Since:
- 2.1.6
-
RICHMEDIAINSTANCE
A name.- Since:
- 2.1.6
-
RICHMEDIAPARAMS
A name.- Since:
- 2.1.6
-
RICHMEDIAPOSITION
A name.- Since:
- 2.1.6
-
RICHMEDIAPRESENTATION
A name.- Since:
- 2.1.6
-
RICHMEDIASETTINGS
A name.- Since:
- 2.1.6
-
RICHMEDIAWINDOW
A name.- Since:
- 2.1.6
-
ROLEMAP
A name -
ROOT
A name -
ROTATE
A name -
ROWS
A name -
RUBY
A name- Since:
- 2.1.6
-
RUNLENGTHDECODE
A name -
RV
(Optional) A rich text string; described in the PDF Specification Annex M -
S
A name -
SATURATION
A name -
SCHEMA
A name -
SCREEN
A name -
SCRIPTS
A name.- Since:
- 2.1.6
-
SECT
A name -
SEPARATION
A name -
SETOCGSTATE
A name -
SETTINGS
A name.- Since:
- 2.1.6
-
SHADING
A name -
SHADINGTYPE
A name -
SHIFT_JIS
A name -
SIG
A name -
SIGFIELDLOCK
The type name of a signature field lock dictionary -
SIGFLAGS
A name -
SIGREF
A name -
SIMPLEX
A name -
SINGLEPAGE
A name -
SIZE
A name -
SMASK
A name -
SORT
A name -
SOUND
A name.- Since:
- 2.1.6
-
SPAN
A name -
SPEED
A name.- Since:
- 2.1.6
-
SPLIT
A name -
SQUARE
A name -
SQUIGGLY
A name- Since:
- 2.1.3
-
ST
A name -
STAMP
A name -
STANDARD
A name -
STATE
(Optional; PDF 1.5) The state to which the original annotation should be set. Default: "Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review". (Additional entries specific to a text annotation) -
STATEMODEL
(Required if State is present, otherwise optional; PDF 1.5) The state model corresponding to State; see "Annotation States" above. (Additional entries specific to a text annotation) -
STDCF
A name -
STEMV
A name -
STMF
A name -
STRF
A name -
STRIKEOUT
A name -
STRUCTPARENT
(Required if the annotation is a structural content item) The integer key of the annotation's entry in the structural parent tree. -
STRUCTPARENTS
A name -
STRUCTTREEROOT
A name -
STYLE
A name -
SUBFILTER
A name -
SUBJ
(Optional; PDF 1.5) Text representing a short description of the subject being addressed by the annotation. (Additional entry specific to markup annotations) -
SUBJECT
A name -
SUBMITFORM
A name -
SUBTYPE
(Required) The type of annotation that this dictionary describes. -
SUPPLEMENT
A name -
SV
(Optional; shall be an indirect reference) A seed value dictionary containing information that constrains the properties of a signature that is applied to this field. -
SW
A name -
SYMBOL
A name of a base 14 type 1 font -
SYMBOLOGY
(Required; ExtensionLevel 3) Specifies which barcode or glyph technology is to be used on this annotation. Supported values are PDF417, QRCode, and DataMatrix. (Entries in a PaperMetaData generation parameters dictionary) -
T
(Required) The partial field name. -
TA
A name- Since:
- 2.1.6
-
TABLE
A name- Since:
- 2.1.6
-
TABS
A name- Since:
- 2.1.5
-
TBODY
A name- Since:
- 2.1.6
-
TD
A name- Since:
- 2.1.6
-
TEXT
A name -
TFOOT
A name- Since:
- 2.1.6
-
TH
A name- Since:
- 2.1.6
-
THEAD
A name- Since:
- 2.1.6
-
THUMB
A name -
THREADS
A name -
TI
(Optional) For scrollable list boxes, the top index (the index in the Opt array of the first option visible in the list). Default value: 0. -
TIME
A name- Since:
- 2.1.6
-
TILINGTYPE
A name -
TIMES_ROMAN
A name of a base 14 type 1 font -
TIMES_BOLD
A name of a base 14 type 1 font -
TIMES_ITALIC
A name of a base 14 type 1 font -
TIMES_BOLDITALIC
A name of a base 14 type 1 font -
TITLE
A name -
TK
A name -
TM
Optional) The mapping name that shall be used when exporting interactive form field data from the document. -
TOC
A name- Since:
- 2.1.6
-
TOCI
A name- Since:
- 2.1.6
-
TOGGLE
A name -
TOOLBAR
A name.- Since:
- 2.1.6
-
TOUNICODE
A name -
TP
A name -
TABLEROW
A name- Since:
- 2.1.6
-
TRANS
A name -
TRANSFORMPARAMS
A name -
TRANSFORMMETHOD
A name -
TRANSPARENCY
A name -
TRANSPARENT
A name.- Since:
- 2.1.6
-
TRAPPED
A name -
TRIMBOX
A name -
TRUETYPE
A name -
TRUSTEDMODE
Parts of the Build Data Dictionary If the value is true, the application was in trusted mode when signing took place. The default value is false. A viewing application is in trusted mode when only reviewed code is executing, where reviewed code is code that does not affect the rendering of PDF files in ways that are not covered by the PDF Reference. -
TU
(Optional) An alternative field name that shall be used in place of the actual field name wherever the field shall be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document's contents in support of accessibility to users with disabilities or for other purposes. -
TWOCOLUMNLEFT
A name -
TWOCOLUMNRIGHT
A name -
TWOPAGELEFT
A name -
TWOPAGERIGHT
A name -
TX
A name -
TYPE
There are lots of Type s in the PDF specification. The following dictionaries use Type:- Crypt filters
- object stream dictionary
- cross-reference stream dictionary
- encrypted payload dictionary
- catalog dictionary
- page tree node
- page object
- file specification dictionary
- embedded file stream dictionary
- collection item dictionary
- collection subitem dictionary
- extensions dictionary
- developer extensions dictionary
- graphics state parameter dictionary
- Type 1 pattern dictionary
- DSS dictionary
- Type 2 pattern dictionary
- image dictionary
- Type 1 form dictionary
- group attributes dictionary
- content group dictionary
- content membership dictionary
- Type 1 font dictionary
- Type 3 font dictionary
- encoding dictionary
- outline dictionary
- annotation dictionaries
- field lock dictionary
- ...
-
TYPE0
A name -
TYPE1
A name -
TYPE3
A name of an attribute. -
U
A name of an attribute. -
UE
(Required if R=6 (PDF 2.0)) A 32-byte string, based on the user password, that shall be used in computing the file encryption key. -
UF
A name of an attribute. -
UHC
A name of an attribute. -
UNDERLINE
A name of an attribute. -
UR
A name -
UR3
A name -
URI
A name -
URL
A name -
USAGE
A name -
USEATTACHMENTS
A name -
USENONE
A name -
USEOC
A name -
USEOUTLINES
A name -
USER
A name -
USERPROPERTIES
A name -
USERUNIT
A name -
USETHUMBS
A name -
V
(Optional; inheritable) The field value, whose format varies depending on the field type. See the descriptions of individual field types for further information. -
V2
(Deprecated) The application shall ask the security handler for the file encryption key and shall implicitly decrypt data with7.6.3.1, "Algorithm 1: Encryption of data using the RC4 or AESalgorithms", using the RC4 algorithm. -
VALIGN
A name.- Since:
- 2.1.6
-
VERISIGN_PPKVS
A name -
VERSION
A name -
VIDEO
A name.- Since:
- 2.1.6
-
VIEW
A name -
VIEWS
A name.- Since:
- 2.1.6
-
VIEWAREA
A name -
VIEWCLIP
A name -
VIEWERPREFERENCES
A name -
VIEWSTATE
A name -
VISIBLEPAGES
A name -
VOFFSET
A name.- Since:
- 2.1.6
-
VRI
This dictionary contains Signature VRI dictionaries (see PDF 2.0 ch. 12.8.4.4,"Validation-related information (VRI)"). The key of each entry in this dictionary is the base-16-encoded (uppercase) SHA1 digest of the signature to which it applies a and the value is the Signature VRI dictionary which contains the validation-related information for that signature. -
W
A name of an attribute. -
W2
A name of an attribute. -
WARICHU
A name- Since:
- 2.1.6
-
WC
A name of an attribute. -
WIDGET
A name of an attribute. -
WIDTH
A name of an attribute. -
WIDTHS
A name -
WIN
A name of an encoding -
WIN_ANSI_ENCODING
A name of an encoding -
WINDOW
A name.- Since:
- 2.1.6
-
WINDOWED
A name.- Since:
- 2.1.6
-
WIPE
A name of an encoding -
WHITEPOINT
A name -
WP
A name -
WS
A name of an encoding -
X
A name -
XA
A name.- Since:
- 2.1.6
-
XD
A name.- Since:
- 2.1.6
-
XFA
A name -
XML
A name -
XOBJECT
A name -
XSTEP
A name -
XREF
A name -
XREFSTM
A name -
XYZ
A name -
YSTEP
A name -
ZADB
A name -
ZAPFDINGBATS
A name of a base 14 type 1 font -
ZOOM
A name -
staticNames
map strings to all known static names- Since:
- 2.1.6
-
widgetNames
List of names used for widget annotations -
formfieldNames
List of names used in form field dictionaries -
hash
private int hash
-
-
Constructor Details
-
PdfName
Constructs a newPdfName
. The name length will be checked.- Parameters:
name
- the new name
-
PdfName
Constructs a newPdfName
.- Parameters:
name
- the new namelengthCheck
- iftrue
check the length validity, iffalse
the name can have any length
-
PdfName
public PdfName(byte[] bytes) Constructs a PdfName.- Parameters:
bytes
- the byte representation of the name
-
-
Method Details
-
initLists
private static void initLists() -
getWidgetNames
-
getFormfieldNames
-
encodeName
Encodes a plain name given in the unescaped form "AB CD" into "/AB#20CD".- Parameters:
name
- the name to encode- Returns:
- the encoded name
- Since:
- 2.1.5
-
decodeName
Decodes an escaped name given in the form "/AB#20CD" into "AB CD".- Parameters:
name
- the name to decode- Returns:
- the decoded name
-
compareTo
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.- Specified by:
compareTo
in interfaceComparable<PdfName>
- Parameters:
name
- the Object to be compared.- Returns:
- a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
- Throws:
ClassCastException
- if the specified object's type prevents it from being compared to this Object.
-
equals
Indicates whether some other object is "equal to" this one. -
hashCode
public int hashCode()Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided byjava.util.Hashtable
.
-