Public Member Functions | |
PDFObject | cloneObject () |
Clone current PDF object and get the cloned PDF object. More... | |
PDFArray | getArray () |
Get the PDF array object of current PDF object. More... | |
boolean | getBoolean () throws com.foxit.sdk.PDFException |
Get the boolean value of current PDF object. More... | |
DateTime | getDateTime () throws com.foxit.sdk.PDFException |
Get the date time value of current PDF object. More... | |
PDFDictionary | getDict () |
Get the PDF dictionary object of current PDF object. More... | |
PDFObject | getDirectObject () |
Get the direct object of current PDF object. More... | |
float | getFloat () throws com.foxit.sdk.PDFException |
Get the float value of current PDF object. More... | |
int | getInteger () throws com.foxit.sdk.PDFException |
Get the integer value of current PDF object. More... | |
Matrix2D | getMatrix () throws com.foxit.sdk.PDFException |
Get the matrix value of current PDF object. More... | |
String | getName () throws com.foxit.sdk.PDFException |
Get the name value of current PDF object. More... | |
int | getObjNum () |
Get the indirect object number of current PDF object. More... | |
RectF | getRect () throws com.foxit.sdk.PDFException |
Get the rectangle value of current PDF object. More... | |
PDFStream | getStream () |
Get the PDF stream object of current PDF object. More... | |
byte [] | getString () |
Get the string value of current PDF object. More... | |
int | getType () |
Get the type of current PDF object. More... | |
String | getWideString () |
Get the wide string value of current PDF object. More... | |
void | release () |
Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more. More... | |
Static Public Member Functions | |
static PDFObject | createFromBoolean (boolean boolean_value) |
Create a PDF object from a boolean value. More... | |
static PDFObject | createFromDateTime (DateTime date_time) |
Create a PDF object from date time. More... | |
static PDFObject | createFromFloat (float float_value) |
Create a PDF object from a float number. More... | |
static PDFObject | createFromInteger (int integer_value) |
Create a PDF object from a integer number. More... | |
static PDFObject | createFromName (String name) |
Create a PDF object from a string which represents a name. More... | |
static PDFObject | createFromString (String string_value) |
Create a PDF object from string. More... | |
static PDFObject | createReference (PDFDoc document, int object_number) |
Create a reference for an indirect object. More... | |
Static Public Attributes | |
static final int | e_Array = 5 |
PDF array object. | |
static final int | e_Boolean = 1 |
PDF boolean object. | |
static final int | e_Dictionary = 6 |
PDF dictionary object. | |
static final int | e_InvalidType = 0 |
Invalid PDF object type. | |
static final int | e_Name = 4 |
PDF name object. | |
static final int | e_Null = 8 |
PDF null object. | |
static final int | e_Number = 2 |
PDF number object. | |
static final int | e_Reference = 9 |
PDF reference object. | |
static final int | e_Stream = 7 |
PDF stream object. | |
static final int | e_String = 3 |
PDF string object. | |
PDF supports eight basic types of objects:
"Boolean value", "Integer and real number", "String", "Name", "Array", "Dictionary", "Stream", "The null
object". For more details about PDF objects, please refer to Section 3.2 "Objects" in <PDF Reference 1.7>.
Class PDFObject is a base class for all kinds of PDF objects. It offers different functions to create different kind of PDF objects. For "Array", "Dictionary" and "Stream" PDF object, please refer to derived classes PDFArray, PDFDictionary and PDFStream.
If user wants to make a newly created PDF object to be an indirect object, please call function pdf::PDFDoc::addIndirectObject.
PDFObject com.foxit.sdk.pdf.objects.PDFObject.cloneObject | ( | ) |
Clone current PDF object and get the cloned PDF object.
|
static |
Create a PDF object from a boolean value.
boolean_value | A boolean value. |
|
static |
Create a PDF object from date time.
PDF defines a standard date format, which closely follows that of the international standard ASN.1 (Abstract Syntax Notation One), defined in ISO/ IEC 8824 (see the Bibliography). A date is defined as an ASCII string of the form (D:YYYYMMDDHHmmSSOHH'mm').
date_time | A DateTime object. |
|
static |
Create a PDF object from a float number.
float_value | A float value. |
|
static |
Create a PDF object from a integer number.
integer_value | An integer value. |
|
static |
Create a PDF object from a string which represents a name.
name | A string. It should not be an empty string. |
|
static |
Create a PDF object from string.
string_value | A string. It should not be an empty string. |
|
static |
Create a reference for an indirect object.
The indirect object can be retrieved by following methods:
Returned by function pdf::PDFDoc::getIndirectObject.
Returned by function pdf::PDFDoc::addIndirectObject, when try to add a direct PDF object to PDF document and make it to be an indirect object.
document | A valid PDF document object. |
object_number | The indirect object number of the indirect PDF object. This should be above 0. |
PDFArray com.foxit.sdk.pdf.objects.PDFObject.getArray | ( | ) |
Get the PDF array object of current PDF object.
If the type of current PDF object is e_Reference, this function will check the direct PDF object of current PDF object.
boolean com.foxit.sdk.pdf.objects.PDFObject.getBoolean | ( | ) | throws com.foxit.sdk.PDFException |
Get the boolean value of current PDF object.
Only useful when the type of current PDF object is e_Boolean.
DateTime com.foxit.sdk.pdf.objects.PDFObject.getDateTime | ( | ) | throws com.foxit.sdk.PDFException |
Get the date time value of current PDF object.
Only useful when the type of current PDF objec is e_String and its content is in PDF standard date format.
PDFDictionary com.foxit.sdk.pdf.objects.PDFObject.getDict | ( | ) |
Get the PDF dictionary object of current PDF object.
If the type of current PDF object is e_Reference, this function will check the direct PDF object of current PDF object.
PDFObject com.foxit.sdk.pdf.objects.PDFObject.getDirectObject | ( | ) |
Get the direct object of current PDF object.
If the type of current PDF object is e_Reference, the direct object will be returned.
float com.foxit.sdk.pdf.objects.PDFObject.getFloat | ( | ) | throws com.foxit.sdk.PDFException |
Get the float value of current PDF object.
Only useful when the type of current PDF object is e_Number.
int com.foxit.sdk.pdf.objects.PDFObject.getInteger | ( | ) | throws com.foxit.sdk.PDFException |
Get the integer value of current PDF object.
Only useful when the type of current PDF object is e_Number.
Matrix2D com.foxit.sdk.pdf.objects.PDFObject.getMatrix | ( | ) | throws com.foxit.sdk.PDFException |
Get the matrix value of current PDF object.
Only useful for PDF object whose type is e_Array and it has 6 number objects as elements.
String com.foxit.sdk.pdf.objects.PDFObject.getName | ( | ) | throws com.foxit.sdk.PDFException |
int com.foxit.sdk.pdf.objects.PDFObject.getObjNum | ( | ) |
Get the indirect object number of current PDF object.
RectF com.foxit.sdk.pdf.objects.PDFObject.getRect | ( | ) | throws com.foxit.sdk.PDFException |
Get the rectangle value of current PDF object.
Only useful for PDF object whose type is e_Array and it has 4 number objects as elements.
PDFStream com.foxit.sdk.pdf.objects.PDFObject.getStream | ( | ) |
Get the PDF stream object of current PDF object.
If the type of current PDF object is e_Reference, this function will check the direct PDF object of current PDF object.
byte[] com.foxit.sdk.pdf.objects.PDFObject.getString | ( | ) |
Get the string value of current PDF object.
This function will get the string format for actual value of current PDF object:
If object type is e_Boolean, "true" or "false" string value will be returned, depending on its actual value.
If object type is e_Number, the value will be represents as a string. For example, "1.5" string is for value 1.5.
If object type is e_String, the string value will be retrieved directly.
If value of current PDF object cannot be converted to a valid string, an empty string will be returned.
int com.foxit.sdk.pdf.objects.PDFObject.getType | ( | ) |
Get the type of current PDF object.
String com.foxit.sdk.pdf.objects.PDFObject.getWideString | ( | ) |
Get the wide string value of current PDF object.
This function will get the string format for actual value of current PDF object:
If object type is e_Boolean, "true" or "false" string value will be returned, depending on its actual value.
If object type is e_Number, the value will be represents as a string. For example, "1.5" string is for value 1.5.
If object type is e_String, the string value will be retrieved directly.
If value of current PDF object cannot be converted to a valid string, an empty string will be returned.
void com.foxit.sdk.pdf.objects.PDFObject.release | ( | ) |
Release a newly created PDF object or a clone PDF object, which is not related to PDF document or other PDF object and will not be used any more.
This function should be called only for a newly created PDF object or a cloned PDF object, which has not been added or set to other PDF object or related to PDF document, and will not be used any more. Please do not use this function for other case, otherwise unknown error may occur.