PdfName
Overview
PdfName is a class in Aspose.PDF FOSS for Java.
Inherits from: PdfBase, Comparable<PdfName>.
PDF name object (§7.3.5, ISO 32000-1:2008).
This class provides 15 methods for working with PdfName objects in Java programs.
Available methods include: accept, compareTo, equals, fromPdfToken, getName, getObjectKey, getValue, hashCode, isDirty, isIndirect, of, setDirty, and 3 additional methods.
All public members are accessible to any Java application after installing the Aspose.PDF FOSS for Java package.
Properties: ANNOTS, ARTBOX, ASCII85_DECODE, ASCII_HEX_DECODE, BASE_FONT, BBOX, and 55 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
name | String | Read | Returns the decoded name (without leading ‘/’). |
value | String | Read | Returns the decoded name value. |
TYPE | PdfName | Read | Gets the type. |
SUBTYPE | PdfName | Read | Gets the subtype. |
PAGES | PdfName | Read | Gets the pages. |
PAGE | PdfName | Read | Gets the page. |
FONT | PdfName | Read | Gets the font. |
LENGTH | PdfName | Read | Gets the length. |
FILTER | PdfName | Read | Gets the filter. |
FLATE_DECODE | PdfName | Read | Gets the flate decode. |
LZW_DECODE | PdfName | Read | Gets the lzw decode. |
ASCII_HEX_DECODE | PdfName | Read | Gets the ascii hex decode. |
ASCII85_DECODE | PdfName | Read | Gets the ascii85 decode. |
RUN_LENGTH_DECODE | PdfName | Read | Gets the run length decode. |
CCITTFAX_DECODE | PdfName | Read | Gets the ccittfax decode. |
DCT_DECODE | PdfName | Read | Gets the dct decode. |
JPX_DECODE | PdfName | Read | Gets the jpx decode. |
WIDTH | PdfName | Read | Gets the width. |
HEIGHT | PdfName | Read | Gets the height. |
RESOURCES | PdfName | Read | Gets the resources. |
CONTENTS | PdfName | Read | Gets the contents. |
MEDIABOX | PdfName | Read | Gets the mediabox. |
CROPBOX | PdfName | Read | Gets the cropbox. |
TRIMBOX | PdfName | Read | Gets the trimbox. |
BLEEDBOX | PdfName | Read | Gets the bleedbox. |
ARTBOX | PdfName | Read | Gets the artbox. |
COUNT | PdfName | Read | Gets the count. |
KIDS | PdfName | Read | Gets the kids. |
PARENT | PdfName | Read | Gets the parent. |
CATALOG | PdfName | Read | Gets the catalog. |
ROOT | PdfName | Read | Gets the root. |
SIZE | PdfName | Read | Gets the size. |
PREV | PdfName | Read | Gets the prev. |
INFO | PdfName | Read | Gets the info. |
ID | PdfName | Read | Gets the id. |
ENCRYPT | PdfName | Read | Gets the encrypt. |
DECODE_PARMS | PdfName | Read | Gets the decode parms. |
ENCODING | PdfName | Read | Gets the encoding. |
BASE_FONT | PdfName | Read | Gets the base font. |
FIRST_CHAR | PdfName | Read | Gets the first char. |
LAST_CHAR | PdfName | Read | Gets the last char. |
WIDTHS | PdfName | Read | Gets the widths. |
TO_UNICODE | PdfName | Read | Gets the to unicode. |
FONT_DESCRIPTOR | PdfName | Read | Gets the font descriptor. |
XOBJECT | PdfName | Read | Gets the xobject. |
IMAGE | PdfName | Read | Gets the image. |
FORM | PdfName | Read | Gets the form. |
BBOX | PdfName | Read | Gets the bbox. |
MATRIX | PdfName | Read | Gets the matrix. |
ANNOTS | PdfName | Read | Gets the annots. |
RECT | PdfName | Read | Gets the rect. |
ROTATE | PdfName | Read | Gets the rotate. |
S | PdfName | Read | Gets the s. |
N | PdfName | Read | Gets the n. |
PREDICTOR | PdfName | Read | Gets the predictor. |
COLUMNS | PdfName | Read | Gets the columns. |
COLORS | PdfName | Read | Gets the colors. |
BITS_PER_COMPONENT | PdfName | Read | Gets the bits per component. |
dirty | boolean | Read | Returns {@code true} if this object was modified since loading. |
indirect | boolean | Read | Returns whether this object is an indirect object (has an object key). |
objectKey | PdfObjectKey | Read | Returns the indirect object key, or {@code null} for direct objects. |
Methods
| Signature | Description |
|---|---|
of(name: String) → PdfName | Returns a PdfName for the given decoded name. |
fromPdfToken(pdfToken: String) → PdfName | Decodes a PDF name token (with {@code #XX} hex escapes) to a PdfName. |
getName() → String | Returns the decoded name (without leading ‘/’). |
getValue() → String | Returns the decoded name value. |
writeTo(os: OutputStream) | |
accept(visitor: IPdfVisitor<T>) → T | |
compareTo(other: PdfName) → int | |
equals(o: Object) → boolean | |
hashCode() → int | |
toString() → String | |
isDirty() → boolean | Returns {@code true} if this object was modified since loading. |
setDirty(dirty: boolean) | Sets the dirty flag on this object. |
isIndirect() → boolean | Returns whether this object is an indirect object (has an object key). |
getObjectKey() → PdfObjectKey | Returns the indirect object key, or {@code null} for direct objects. |
setObjectKey(key: PdfObjectKey) | Sets the indirect object key. |