Package com.gnostice.pdfone

Contains important classes in PDFOne Java (start with PdfDocument).

See:
Description

Interface Summary

PdfBookmarkMergeHandler	This interface defines a run-time event generated by overloaded PdfDocument.merge() methods.
PdfCustomPlaceholderHandler	This interface defines a run-time event that can be used to track/modify custom placeholders in text rendered on a document.
PdfDestination	This interface defines constants specifying how the viewer application window needs to be placed on a page.
PdfFormFieldRenameHandler	This interface defines an run-time event generated by method PdfDocument.write() (in reading mode) when a form field is saved to the document.
PdfNeedFileNameHandler	This interface defines a run-time event that can be used to track/provide file names for documents generated by an overloaded PdfDocument.split() method.
PdfNumber
PdfPageLayout	This interface defines constants for specifying page layout to be used when document is displayed.
PdfPageMode	This interface defines constants for specifying how document should be displayed.
PdfPageReadHandler	This class provides an event when a page is read from an existing document.
PdfPageSize	This interface defines constants for various page sizes including both ISO and North American paper sizes.
PdfPasswordHandler	This interface provides an event that is raised when a password-protected document is being read.
PdfPreferences	This interface defines constants for setting viewer application preferences when displaying a PDF document.
PdfSaveAsImageHandler	This interface defines a run-time event that is generated when an overloaded PdfDocument.saveAsImage() method tries to save the image of a page.
Usable

Class Summary

PdfAction	This abstract class represents an action that will be executed by a viewer displaying the document.
PdfAction.PdfEvent	This inner class represents an event inside a viewer displaying a PDF document.
PdfAnnot	This is an abstract class representing annotations and also form fields.
PdfAppearanceStream	This class represents an appearance stream.
PdfArray
PdfBookmark	This class represents a bookmark in a document.
PdfBookmark.RemoteGoTo
PdfBoolean
PdfByteOutputStream
PdfCaretAnnot	This class represents a caret annotation.
PdfCell	This class represents a cell in a table.
PdfCircleAnnot	This class represents a circle annotation.
PdfDict
PdfDocument	This class is used to create, read from, and write to PDF documents.
PdfEncryption	This class is used to specify the encryption settings and access permissions for a document.
PdfExtGraphicState
PdfFileAttachmentAnnot	This class represents a file attachment annotation.
PdfFloat
PdfFormCheckBox	This class represents a check box form field.
PdfFormComboBox	This class represents a combo box.
PdfFormField	This is a base class from which all form field classes are derived.
PdfFormListBox	This represents a list box.
PdfFormPushButton	This class represents a push button that can be used to submit or reset a form.
PdfFormRadioButton	This class represents a radio button form field.
PdfFormTextField	This class represents a text box form field.
PdfFreeTextAnnot	This class represents a free text annotation.
PdfGotoAction	This class represents a "go-to" action.
PdfImage	This class represents an image that can be used in a document or page.
PdfIndirectReference
PdfInkAnnot	This represents an ink annotation.
PdfInteger
PdfJavascriptAction	This class represents a JavaScript action.
PdfLaunchAction	This class represents a launch action.
PdfLineAnnot	This class represents a line annotation.
PdfLinkAnnot	This class represents a link annotation.
PdfLong
PdfMarkupAnnot	This class represents a text markup annotation.
PdfMeasurement	This class defines measurement units and provides static methods for converting values from one unit to another.
PdfMessages
PdfName
PdfNamedAction	This class represents a named action.
PdfNull
PdfObject
PDFOne	This class enables validation of user license key.
PdfPage	This class represents a PDF page.
PdfPagePresentation	This class represents a PDF page transition.
PdfPoint	This class represents a point on a page.
PdfPolygonAnnot	This class represents a polygon annotation.
PdfPolylineAnnot	This class represents a polyline annotation.
PdfPopUpAnnot	This class represents a popup annotation.
PdfPreferences.Direction	Contains constants specifying predominant reading order for text.
PdfPreferences.NonFullScreenPageMode	Contains constants specifying how viewer application should display the document after exiting the fullscreen mode.
PdfPrinter	This class represents the printer component of PDFOne Java.
PdfReader	This class is used in conjunction with the PdfDocument class to read and/or modify an existing PDF document.
PdfRect	This class represents a rectangle or rectangular area on a page.
PdfRemoteGotoAction	This class represents a remote go-to action.
PdfSaveAsImageAdapter	This class provides empty onSaveAsImage() event handlers that can be extended by user classes so as to track or control how each image is saved from a page.
PdfSquareAnnot	This class represents a square annotation.
PdfStampAnnot	This class represents a stamp annotation.
PdfStream
PdfString
PdfTable	This represents a table that can be rendered in a document.
PdfTextAnnot	This class represents a text annotation.
PdfTextFormatter	This class is used to retrieve and specify settings related to text formatting.
PdfTextString
PdfURIAction	This class represents a URI action.
PdfViewer	This class represents a container for displaying an existing PDF documents.
PdfWatermarkAnnot	This class represents a watermark annotation.
PdfWriter	This class is used in conjunction with the PdfDocument class to create new PDF documents.

Exception Summary

PdfBadFileException
PdfException

Package com.gnostice.pdfone Description

Contains important classes in PDFOne Java (start with PdfDocument).

To create a PDF document:

• Create a PdfWriter instance (specify the file name or memory stream here)
• Create a PdfDocument instance with the PdfWriter instance
• Use PdfDocument object's methods to
  • render PDF elements such as text, shapes, and images.
  • add PDF document components such as pages, bookmarks

Save final document to a file or a memory stream

Close I/O stream associated with the PdfWriter instance.

// Create a PdfWriter instance
PdfWriter w = PdfWriter.fileWriter("sample_doc1.pdf");

// Create a PdfDocument instance with the PdfWriter
PdfDocument d = new PdfDocument(w);

// Write some text on page 1
d.writeText("Hello, World!");

// Write document to file
d.write();

// Close all I/O streams associated with the PDF writer
w.dispose();

To read a PDF document, create a PdfDocument with a PdfReader object.

// Create a PdfReader instance
PdfReader r = PdfReader.fileReader("sample_doc1.pdf");

// Create a PdfDocument instance with the reader
PdfDocument d = new PdfDocument(r);

// Get page count and display on console
System.out.println(
        "Number of pages in sample_doc1.pdf is " +
        d.getPageCount());

// Close all I/O streams associated with the PDF reader
r.dispose();

Documentation Includes

• this API documentation
• example code linked by the API documentation
• sample code in PDFOne Java installation folder
• online newsletter articles