package

com.pdftron.pdf

Interfaces

__Delete  
ConnectionErrorProc ConnectionErrorProc is an interface for a custom handler that that can be passed into SetConnectionErrorProc. 
ErrorReportProc ErrorReportProc is an interface for a custom handler that that can be used to report potential rendering errors in PDFViewCtrl, PDFDraw, or PDFRasterizer. 
JavaScriptEventProc The Interface JavaScriptEventProc  
PDFViewCtrl.ActionCompletedListener Callback interface invoked when an action is completed  
PDFViewCtrl.DocumentDownloadListener Used for receiving updates from document downloading, which can be started by openUrlAsync(String, String, String, HTTPRequestOptions)  
PDFViewCtrl.DocumentLoadListener Used for receiving notifications about the document state. 
PDFViewCtrl.ErrorReportListener Used for receiving error reports in case an error is encountered during page rendering. 
PDFViewCtrl.LockRunnable Runnable used in conjunction with document locking helper methods. 
PDFViewCtrl.OnCanvasSizeChangeListener Used for tracking current canvas size changes  
PDFViewCtrl.PageChangeListener Used for receiving notifications in UI thread when the current page changes. 
PDFViewCtrl.PageSlidingListener Used for receiving events when PDFViewCtrl undergoes page sliding transformation. 
PDFViewCtrl.RenderingListener Used for receiving notifications of the start and end of the rendering of the client area. 
PDFViewCtrl.TextSearchListener Used for receiving notifications in UI thread during the process of text search. 
PDFViewCtrl.ThumbAsyncListener Used for receiving events from a request for thumbnails. 
PDFViewCtrl.ToolManager Tool manager interface that is used for creating tools. 
PDFViewCtrl.UniversalDocumentConversionListener Used for receiving updates from universal document conversion when document are opened by by openUniversalDocument(DocumentConversion)
PDFViewCtrl.UniversalDocumentProgressIndicatorListener Used for receiving notifications of the current blank page whose content generation is in progress. 
PreviewHandler.PreviewHandlerCallback  
Print.PrintCallback PrintCallback interface provides a way for users to receive callback when print job is finished. 
ProgressMonitor ProgressMonitor is an interface that an application can use to indicate the progress of a lengthy operation (such as PDFDoc.Save()). 
RequestHandler.RequestHandlerCallback  
RequestRenderInWorkerThreadProc RequestRenderInWorkerThreadProc is an interface for a custom handler that issues a rendering request from the UI thread. 
ThumbAsyncHandler ThumbAsyncHandler is an interface for a custom handler that that can be passed into GetThumbAsync. 

Classes

Action Actions are typically what happens when a user clicks on a link or bookmark. 
ActionParameter Container for parameters used in handling various actions. 
AdvancedImagingConvertOptions  
AdvancedImagingModule The class AdvancedImagingModule. 
AnalyticsHandlerCallback  
Annot Annot is a base class for different types of annotations. 
Annot.BorderStyle BorderStyle structure specifies the characteristics of the annotation's border. 
AssertHandlerCallback  
BlackBoxContext The class BlackBoxContext. 
Bookmark A %PDF document may optionally display a document outline on the screen, allowing the user to navigate interactively from one part of the document to another. 
CADConvertOptions  
CADModule The class CADModule. 
CancelFlag  
CharData CharData is a data structure returned by CharIterator that is used to provide extra information about a character within a text run. 
CharIterator CharIterator is an iterator type that can be used to traverse CharData in the current e_text element. 
ColorPt ColorPt is an array of colorants (or tint values) representing a color point in an associated color space. 
ColorSpace This abstract class is used to serve as a color space tag to identify the specific color space of a Color object. 
ContentReplacer ContentReplacer is a utility class for replacing content (text and images) in existing PDF (template) documents. 
ConversionOptions  
Convert Converter is a utility class used to convert documents and files to PDF. 
Convert.EPUBOutputOptions A class containing options common to ToEpub functions  
Convert.ExcelOutputOptions A class containing options common to toExcel functions  
Convert.HTMLOutputOptions A class containing options common to ToHtml and ToEpub functions  
Convert.OutputOptionsOCR A class containing OCR options common to the ToHtml, ToWord, ToExcel, ToPowerPoint functions  
Convert.PowerPointOutputOptions A class containing options common to toPowerPoint functions  
Convert.SVGOutputOptions A class containing options for ToSvg functions  
Convert.TiffOutputOptions A class containing options common to ToTiff functions  
Convert.WordOutputOptions A class containing options common to toWord functions  
Convert.XODOutputOptions A class containing options for ToXod functions  
Convert.XPSOutputCommonOptions A class containing options common to ToXps and ToXod functions  
Convert.XPSOutputOptions A class containing options for ToXps functions  
CubicCurveBuilder The class CubicCurveBuilder. 
CurvePainter  
DataExtractionModule The class DataExtractionModule. 
DataExtractionOptions  
Date The Date class is a utility class used to simplify work with PDF date objects. 
Destination A destination defines a particular view of a document, consisting of the following: - The page of the document to be displayed - The location of the document window on that page - The magnification (zoom) factor to use when displaying the page Destinations may be associated with Bookmarks, Annotations, and Remote Go-To Actions. 
DiffOptions  
DigitalSignatureField A class representing a digital signature form field. 
DigitalSignatureFieldIterator DigitalSignatureFieldIterator is an iterator type that can be used to traverse a list of form fields in a PDF document. 
DisallowedChange The class DisallowedChange. 
DocumentConversion The class DocumentConversion. 
DocumentPreviewCache DocumentPreviewCache is a persistent cache that provides thumbnails for browsing in PDFNet. 
Element Element is the abstract interface used to access graphical elements used to build the display list. 
ElementBuilder ElementBuilder is used to build new PDF.Elements (e.g. 
ElementReader ElementReader can be used to parse and process content streams. 
ElementWriter ElementWriter can be used to assemble and write new content to a page, Form XObject, Type3 Glyph stream, pattern stream, or any other content stream. 
EmbeddedTimestampVerificationResult This class represents the result of verifying a secure embedded timestamp digital signature. 
ExternalAnnotManager The class ExternalAnnotManager. 
Field An interactive form (sometimes referred to as an AcroForm) is a collection of fields for gathering information interactively from the user. 
FieldIterator FieldIterator is an iterator type that can be used to traverse a list of form fields in a PDF document. 
FileSpec FileSpec corresponds to the PDF file specification object. 
Flattener Flattener is a optional PDFNet add-on that can be used to simplify and optimize existing PDF's to render faster on devices with lower memory and speeds. 
Font A font that is used to draw text on a page. 
FontCharCodeIterator FontCharCodeIterator is an iterator type that can be used to traverse a list of visible char codes in a font embedded in PDF. 
Function Although PDF is not a programming language it provides several types of function object that represent parameterized classes of functions, including mathematical formulas and sampled representations with arbitrary resolution. 
GeometryCollection The class GeometryCollection. 
GeometryCollection.SnappingMode  
GSChangesIterator GSChangesIterator is an iterator type that can be used to traverse a list of changes in the graphics state between subsequnet graphical elements on the page. 
GState GState is a class that keeps track of a number of style attributes used to visually define graphical Elements. 
Highlights

Highlights is used to store the necessary information and perform certain tasks in accordance with Adobe's Highlight standard, whose details can be found at http://partners.adobe.com/public/developer/en/pdf/HighlightFileFormat.pdf

Image Image class that provides common methods for working with PDF images. 
Image.Compat Compatibility layer for older API. 
Image2RGB Image2RGB is a filter that can decompress and normalize any PDF image stream (e.g. 
Image2RGBA Image2RGBA is a filter that can decompress and normalize any PDF image stream (e.g. 
KeyStrokeActionResult A class that contains information from a KeyStrokeAction  
KeyStrokeEventData KeyStokeEventData contains information for executing KeyStrokeAction. 
LogMessageHandlerCallback  
MarkdownToPDFOptions  
MergeXFDFOptions  
OCRModule The class OCRModule. 
OCROptions  
OfficeLocaleOverrides  
OfficeToPDFOptions  
Optimizer  
Optimizer.ImageSettings A class that stores downsampling/recompression settings for color and grayscale images. 
Optimizer.MonoImageSettings A class that stores image downsampling/recompression settings for monochrome images. 
Optimizer.OptimizerSettings A class that stores settings for the optimizer  
Optimizer.TextSettings A class that stores text optimization settings. 
OptionsBase  
Page Page is a high-level class representing PDF page object (see 'Page Objects' in Section 3.6.2, 'Page Tree,' in PDF Reference Manual). 
PageIterator PageIterator is an iterator type that can be used to traverse a list pages in a PDF document. 
PageLabel PDF page labels can be used to describe a page. 
PageSet PageSet is a container of page numbers ordered following a linear sequence. 
PathData Contains the information required to draw the path. 
PatternColor Patterns are quite general, and have many uses; for example, they can be used to create various graphical textures, such as weaves, brick walls, sunbursts, and similar geometrical and chromatic effects. 
PDF2HtmlReflowParagraphsModule The class PDF2HtmlReflowParagraphsModule. 
PDF2WordModule The class PDF2WordModule. 
PDFDoc PDFDoc is a high-level class describing a single PDF (Portable Document Format) document. 
PDFDocGenerator The class PDFDocGenerator. 
PDFDocInfo PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata. 
PDFDocViewPrefs PDFDocViewPrefs is a high-level utility class that can be used to control the way the document is to be presented on the screen or in print. 
PDFDocWithoutOwnership Doc created for debugging purposes to be used until we sort out ownership issues for documents created through universal conversion. 
PDFDraw PDFDraw contains methods for converting PDF pages to images and to Bitmap objects. 
PDFDraw.IntBufferData  
PDFNet PDFNet contains global library initialization, registration, configuration, and termination methods. 
PDFNetInternalTools The class PDFNetInternalTools. 
PDFRasterizer PDFRasterizer is a low-level PDF rasterizer. 
PDFViewCtrl PDFViewCtrl is derived from android.view.ViewGroup and encapsulates a rich set of functionalities for interactive viewing of PDF documents. 
PDFViewCtrl.HTTPRequestOptions Class for customizing network requests. 
PDFViewCtrl.LinkInfo A class that holds information for a link. 
PDFViewCtrl.Selection Class that represents the current text selection by PDFViewCtrl. 
Point The Class Point. 
PreviewHandler PreviewHandler is an interface for a custom handler that can be passed into DocumentPreviewCache GetBitmap. 
Print Print is a utility class that can be used to print PDF documents. 
Print.Compat Compatibility layer for older API. 
PrintToPdfModule The class PrintToPdfModule. 
PrintToPdfOptions  
QuadPoint The Class QuadPoint. 
Rect Rect is a utility class used to manipulate PDF rectangle objects (refer to section 3.8.3 of the PDF Reference Manual). 
RectCollection  
Redactor PDF Redactor is a separately licensable Add-on that offers options to remove (not just covering or obscuring) content within a region of PDF. 
Redactor.Appearance Class used to customize the appearance of the optional redaction overlay. 
Redactor.Redaction  
Reflow The class Reflow. 
ReflowProcessor ReflowProcessor is a processor that manages the requests of converting PDF page documents to reflow documents as HTML files. 
RefreshOptions  
RequestHandler RequestHandler is an interface for a custom handler that can be passed into ReflowProcessor.GetReflow, PreviewProcessor.GetBitmap, etc. 
Separation Separation contains a memory buffer and CMYK components' information about rasterized separations used in PDFDraw.getSeparationBitmaps() and PDFRasterizer.rasterizeSeparations()

Note: This class is available on all platforms supported by PDFNet. 

Shading Shading is a class that represents a flat interface around all PDF shading types: - In Function-based (type 1) shadings, the color at every point in the domain is defined by a specified mathematical function. 
ShapedText The class ShapedText. 
ShapedText.FailureReason  
ShapedText.ShapingStatus  
Stamper Stamper is a utility class that can be used to PDF pages with text, images, or with other PDF content in only a few lines of code. 
StrokeOutlineBuilder StrokeOutlineBuilder is a class used to generate a stroke outline. 
StructuredOutputModule The class StructuredOutputModule. 
SVGConvertOptions  
TempDoc  
TemplateDocument The class TemplateDocument. 
Text2PDFOptions  
TextDiffOptions  
TextExtractor TextExtractor is used to analyze a PDF page and extract words and logical structures that are visible within a given region. 
TextExtractor.CharRange TextExtractor.CharRange object represents a range of text based on Unicode character indices. 
TextExtractor.Compat Compatibility layer API. 
TextExtractor.Line  
TextExtractor.Style A class representing predominant text style associated with a given Line, a Word, or a Glyph. 
TextExtractor.Word  
TextRange

The TextRange is used to store the necessary information and perform certain It may be the result of a text search, or simply a couple of highlighted or underlined words. 

TextSearch

TextSearch searches through a PDF document for a user-given search pattern. 

TextSearchResult TextSearchResult is used by the TextSearch class for returning a search result. 
TimestampingConfiguration A class representing a set of options for timestamping a document. 
TimestampingResult A class representing the result of testing a timestamping configuration. 
TrustVerificationResult The detailed result of a trust verification step of a verification operation performed on a digital signature. 
VerificationOptions Options pertaining to digital signature verification. 
VerificationResult The result of a verification operation performed on a digital signature. 
ViewChangeCollection Class for collecting changes to a PDFDoc and/or viewer, which can then be passed to various functions to act on. 
ViewerOptimizedOptions A class containing ViewerOptimizedOptions  
WebFontDownloader The class WebFontDownloader. 
WordToPDFOptions  

Enums

CADConvertOptions.LayoutSortOrder Layout sorting options  
Convert.OutputOptionsOCR.LanguageChoice  
Convert.OutputOptionsOCR.PreferredOCREngine  
DataExtractionModule.DataExtractionEngine  
DigitalSignatureField.DocumentPermissions  
DigitalSignatureField.FieldPermissions  
DigitalSignatureField.SubFilterType  
DisallowedChange.Type  
OfficeToPDFOptions.StructureTagLevel Level of detail for structure tags. 
PDFDoc.ActionTriggerMode  
PDFDoc.FlattenMode  
PDFDoc.InsertBookmarkMode  
PDFDoc.SignaturesVerificationStatus  
PDFViewCtrl.AnnotationManagerMode An enum represents annotation manager mode  
PDFViewCtrl.ConversionState An enum represents document conversion state  
PDFViewCtrl.DownloadState An enum represents document download state  
PDFViewCtrl.OverPrintMode Overprint mode. 
PDFViewCtrl.PageChangeState State of page changes. 
PDFViewCtrl.PagePresentationMode Page presentation mode  
PDFViewCtrl.PageViewMode Page view mode  
PDFViewCtrl.PriorEventMode Prior event mode  
PDFViewCtrl.TextSearchResult Text search result state  
PDFViewCtrl.TextSelectionMode Text selection mode  
PDFViewCtrl.ZoomLimitMode Zoom limit mode. 
RequestHandler.JobRequestResult Job request result state  
StrokeOutlineBuilder.TipOptions  
VerificationOptions.CertificateTrustFlag An enumeration representing the level of trust associated with a particular certificate. 
VerificationOptions.SecurityLevel An enumeration representing the level of security to use when verifying digital signatures. 
VerificationOptions.TimeMode An enumeration representing the least-secure type of reference-time to use when verifying digital signatures. 
VerificationResult.DigestStatus  
VerificationResult.DocumentStatus  
VerificationResult.ModificationPermissionsStatus  
VerificationResult.TrustStatus