Overview Package Class Use Tree Deprecated Index Help
Prev Class Next Class Frames NoFrames All Classes
Summary: Nested Field Constr Method Detail: Field Constr Method
com.lowagie.text.pdf
public abstract class PdfObject extends Object
PdfObject is the abstract superclass of all PDF objects.
PDF supports seven basic types of objects: Booleans, numbers, strings, names,
arrays, dictionaries and streams. In addition, PDF provides a null object.
Objects may be labeled so that they can be referred to by other objects.
All these basic PDF objects are described in the 'Portable Document Format
Reference Manual version 1.3' Chapter 4 (pages 37-54).
See Also: PdfNull PdfBoolean PdfNumber PdfString PdfName PdfArray PdfDictionary PdfStream PdfIndirectReference
| Field Summary | |
|---|---|
| static int | ARRAY a possible type of PdfObject |
| protected byte[] | bytes the content of this PdfObject |
| static int | BOOLEAN a possible type of PdfObject |
| static int | DICTIONARY a possible type of PdfObject |
| protected PRIndirectReference | indRef
Holds value of property indRef. |
| static int | INDIRECT a possible type of PdfObject |
| static int | NAME a possible type of PdfObject |
| static String | NOTHING This is an empty string used for the PdfNull-object and for an empty PdfString-object. |
| static int | NULL a possible type of PdfObject |
| static int | NUMBER a possible type of PdfObject |
| static int | STREAM a possible type of PdfObject |
| static int | STRING a possible type of PdfObject |
| protected int | type the type of this PdfObject |
| static String | TEXT_PDFDOCENCODING This is the default encoding to be used for converting Strings into bytes and vice versa.
|
| static String | TEXT_UNICODE This is the encoding to be used to output text in Unicode. |
| Constructor Summary | |
|---|---|
| protected | PdfObject(int type)
Constructs a PdfObject of a certain type without any content.
|
| protected | PdfObject(int type, String content)
Constructs a PdfObject of a certain type with a certain content.
|
| protected | PdfObject(int type, byte[] bytes)
Constructs a PdfObject of a certain type with a certain content.
|
| Method Summary | |
|---|---|
| boolean | canBeInObjStm()
Can this object be in an object stream? |
| byte[] | getBytes()
Gets the presentation of this object in a byte array |
| PRIndirectReference | getIndRef()
Getter for property indRef. |
| boolean | isArray()
Checks if this PdfObject is of the type PdfArray.
|
| boolean | isBoolean()
Checks if this PdfObject is of the type PdfBoolean.
|
| boolean | isDictionary()
Checks if this PdfObject is of the type PdfDictionary.
|
| boolean | isIndirect()
Checks if this is an indirect object. |
| boolean | isName()
Checks if this PdfObject is of the type PdfName.
|
| boolean | isNull()
Checks if this PdfObject is of the type PdfNull.
|
| boolean | isNumber()
Checks if this PdfObject is of the type PdfNumber.
|
| boolean | isStream()
Checks if this PdfObject is of the type PdfStream.
|
| boolean | isString()
Checks if this PdfObject is of the type PdfString.
|
| int | length()
Returns the length of the actual content of the PdfObject.
|
| protected void | setContent(String content)
Changes the content of this PdfObject.
|
| void | setIndRef(PRIndirectReference indRef)
Setter for property indRef. |
| void | toPdf(PdfWriter writer, OutputStream os)
Writes the PDF representation of this PdfObject as an array of bytes to the writer. |
| String | toString()
Returns the String-representation of this PdfObject.
|
| int | type()
Returns the type of this PdfObject.
|
PdfObjectPdfObjectPdfObjectPdfObjectPdfObjectPdfObjectPdfNull-object and for an empty PdfString-object.PdfObjectPdfObjectPdfObjectPdfObjectPdfObjectPdfObject of a certain type without any content.
Parameters: type type of the new PdfObject
PdfObject of a certain type with a certain content.
Parameters: type type of the new PdfObject content content of the new PdfObject as a String.
PdfObject of a certain type with a certain content.
Parameters: type type of the new PdfObject bytes content of the new PdfObject as an array of byte.
Returns: true if this object can be in an object stream.
Returns: a byte array
Returns: Value of property indRef.
PdfObject is of the type PdfArray.
Returns: true or false
PdfObject is of the type PdfBoolean.
Returns: true or false
PdfObject is of the type PdfDictionary.
Returns: true or false
Returns: true if this is an indirect object
PdfObject is of the type PdfName.
Returns: true or false
PdfObject is of the type PdfNull.
Returns: true or false
PdfObject is of the type PdfNumber.
Returns: true or false
PdfObject is of the type PdfStream.
Returns: true or false
PdfObject is of the type PdfString.
Returns: true or false
PdfObject.
In some cases, namely for PdfString and PdfStream,
this method differs from the method pdfLength because pdfLength
returns the length of the PDF representation of the object, not of the actual content
as does the method length.
Remark: the actual content of an object is in some cases identical to its representation. The following statement is always true: length() >= pdfLength().
Returns: a length
PdfObject.
Parameters: content the new content of this PdfObject
Parameters: indRef New value of property indRef.
PdfObject as an array of bytes to the writer.Parameters: writer for backwards compatibility os the outputstream to write the bytes to.
Throws: IOException
String-representation of this PdfObject.
Returns: a String
PdfObject.
Returns: a type