com.datalogics.PDFL

Class PDFName

java.lang.Object

com.datalogics.PDFL.PDFObject

com.datalogics.PDFL.PDFName

public class PDFName
extends PDFObject

Represents a name data element within a PDF document. All objects in a PDF document are built from a collection of simpler objects that represent fundamental datatypes like numbers, strings and arrays. PDFObject and its subclasses allow direct access and manipulation of these simple objects. Some subclasses represent single data elements. For example, PDFName represents a single name value. Others represent a collection of PDFObjects, such as PDFArray, an indexed array of data elements.

A PDFName represents a single indivisible name token, and may be inserted into any collection object. It may also be used as a key in a PDFDictionary.

Constructor Summary

Constructors

Constructor and Description
PDFName(java.lang.String value, Document doc, boolean indirect) General constructor
PDFName(java.lang.String value, PDFObject docFromObj, boolean indirect) General constructor

Method Summary

Modifier and Type	Method and Description
void	delete()
java.lang.String	getValue() String value of this object.
java.lang.String	toString()

Methods inherited from class com.datalogics.PDFL.PDFObject

clone, clone, clone, clone, clone, compareTo, destroy, enumPDFObjects, equals, getDocument, getGeneration, getID, getIndirect, getPDFHashValue

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFName

public PDFName(java.lang.String value,
               Document doc,
               boolean indirect)

General constructor

Parameters:

value - String value representing this PDFName

doc - Document object containing this PDFName

indirect - flag marking this as an indirect PDFObject

PDFName

public PDFName(java.lang.String value,
               PDFObject docFromObj,
               boolean indirect)

General constructor

Parameters:

value - String value representing this PDFName

docFromObj - The new PDFArray will be created in the same document as this object.

indirect - flag marking this as an indirect PDFObject

Method Detail

delete

public void delete()

Overrides:

delete in class PDFObject

toString

public java.lang.String toString()

Overrides:

toString in class PDFObject

getValue

public java.lang.String getValue()

String value of this object.