A B C D E F G H I K L M O P R S T V W X Y

A

AcroButtonField - Class in com.snowtide.pdf.forms
Represents a button form field in an interactive AcroForm.
AcroCheckboxField - Class in com.snowtide.pdf.forms
Instances of this class represent individual checkboxes in an interactive forms.
AcroChoiceField - Class in com.snowtide.pdf.forms
Represents a multiple-choice form field in an interactive AcroForm.
AcroForm - Interface in com.snowtide.pdf.forms
A Form implementation that represents the contents of an interactive PDF form, available via PDFTextStream.getFormData().
AcroFormField - Interface in com.snowtide.pdf.forms
Interface implmented by all form fields held by AcroForm instances.
AcroRadioButtonGroupField - Class in com.snowtide.pdf.forms
Instances of this class represent a group of radio buttons in an interactive forms.
AcroSignatureField - Class in com.snowtide.pdf.forms
Represents a digital signature field in an interactive AcroForm.
AcroTextField - Class in com.snowtide.pdf.forms
Represents a text field in an interactive AcroForm.
addChild(Block) - Method in interface com.snowtide.pdf.layout.BlockParent
 
addColumnPartition(int) - Method in interface com.snowtide.pdf.Page
Adds the given coordinate as an acceptable midline between columns, used when this page is segmented.
addRegion(float, float, float, float) - Method in class com.snowtide.pdf.RegionOutputTarget
Registers a new unnamed region.
addRegion(float, float, float, float, String) - Method in class com.snowtide.pdf.RegionOutputTarget
Registers a new named region.
allowsMultipleChoices() - Method in class com.snowtide.pdf.forms.AcroChoiceField
Returns true if this choice field's widget allows multiple selections.
Annotation - Interface in com.snowtide.pdf.annot
The common interface implemented by all PDF annotation classes.
area() - Method in interface com.snowtide.pdf.layout.Region
 
ATTR_AUTHOR - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating who created a PDF document.
ATTR_CREATION_DATE - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the date and time that a PDF document was created.
ATTR_CREATOR - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the name of the application that created the original document from which the PDF was generated.
ATTR_KEYWORDS - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String containing keywords associated with a PDF document.
ATTR_MOD_DATE - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the date and time that a PDF document was last modified.
ATTR_PRODUCER - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the name of the application that generated a PDF document.
ATTR_SUBJECT - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the subject of a PDF document.
ATTR_TITLE - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve a String indicating the title of a PDF document.
ATTR_TRAPPED - Static variable in class com.snowtide.pdf.PDFTextStream
Document attribute key used to retrieve an indicator as to whether a PDF document includes trapping information (trapping is a method for correcting printing errors in high-quality printing environments).
ATTR_USES_GRAPH_FONTS - Static variable in class com.snowtide.pdf.PDFTextStream
Some PDF files use fonts that are image-based -- instead of their encodings mapping character codes to standard Unicode characters, they map character codes to images of characters.

B

Block - Interface in com.snowtide.pdf.layout
Instances of this class represent groupings of text at a specific position on a Page.
BlockParent - Interface in com.snowtide.pdf.layout
An interface to be implemented by any class that can contain an ordered set of Blocks.
Bookmark - Class in com.snowtide.pdf
Instances of this class form a singly-rooted tree available in some PDF documents.
buildPDFDocument(File) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the contents of the given PDF file reference and a default set of configuration parameters.
buildPDFDocument(InputStream, String) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the PDF document data provided by the given InputStream and a default set of configuration parameters.
buildPDFDocument(File, DocumentFactoryConfig) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the contents of the given PDF file reference and the custom set of configuration parameters specified in the given DocumentFactoryConfig instance.
buildPDFDocument(InputStream, String, DocumentFactoryConfig) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the PDF document data provided by the given InputStream and the custom set of configuration parameters specified in the given DocumentFactoryConfig instance.
buildPDFDocument(ByteBuffer, String) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the PDF document data provided by the given ByteBuffer and a default set of configuration parameters.
buildPDFDocument(ByteBuffer, String, DocumentFactoryConfig) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance based on the PDF document data provided by the given ByteBuffer and the custom set of configuration parameters specified in the given DocumentFactoryConfig instance.
buildPDFDocument(PDFTextStream, DocumentFactoryConfig) - Static method in class com.snowtide.pdf.lucene.PDFDocumentFactory
Creates a new Lucene Document instance using the output of the already-created PDFTextStream instance provided and the custom set of configuration parameters specified in the given DocumentFactoryConfig instance.
BUTTON_TYPE_CHECKBOX - Static variable in class com.snowtide.pdf.forms.AcroButtonField
Code returned by AcroButtonField.getButtonType() when a AcroButtonField represents a checkbox.
BUTTON_TYPE_PUSHBUTTON - Static variable in class com.snowtide.pdf.forms.AcroButtonField
Code returned by AcroButtonField.getButtonType() when a AcroButtonField represents a pushbutton.
BUTTON_TYPE_RADIO_GROUP - Static variable in class com.snowtide.pdf.forms.AcroButtonField
Code returned by AcroButtonField.getButtonType() when a AcroButtonField represents a group of radio buttons.

C

canChangeValue() - Method in class com.snowtide.pdf.forms.AcroCheckboxField
This function always returns true.
canChangeValue() - Method in class com.snowtide.pdf.forms.AcroChoiceField
Always returns true.
canChangeValue() - Method in interface com.snowtide.pdf.forms.AcroFormField
This function returns true only if this form field is of a subtype that supports setting its value.
canChangeValue() - Method in class com.snowtide.pdf.forms.AcroRadioButtonGroupField
This function always returns true.
canChangeValue() - Method in class com.snowtide.pdf.forms.AcroTextField
This function always returns true.
CHOICE_TYPE_COMBO - Static variable in class com.snowtide.pdf.forms.AcroChoiceField
Value returned by AcroChoiceField.getWidgetType(), indicating that an AcroChoiceField is representing a drop-down combo box.
CHOICE_TYPE_LIST - Static variable in class com.snowtide.pdf.forms.AcroChoiceField
Value returned by AcroChoiceField.getWidgetType() indicating that an AcroChoiceField is representing a list that can potentially allow multiple values to be selected.
close() - Method in class com.snowtide.pdf.PDFTextStream
 
COLUMN_POSITION_HALVES - Static variable in interface com.snowtide.pdf.Page
A constant parameter for use with Page.addColumnPartition(int).
COLUMN_POSITION_QUARTERS - Static variable in interface com.snowtide.pdf.Page
A constant parameter for use with Page.addColumnPartition(int).
COLUMN_POSITION_THIRDS - Static variable in interface com.snowtide.pdf.Page
A constant parameter for use with Page.addColumnPartition(int).
com.snowtide.pdf - package com.snowtide.pdf
PDFTextStream is a library that provides high performance, accurate text and metadata extraction, and is easy to integrate with your applications and web services on Java, .NET, and Python environments.
com.snowtide.pdf.annot - package com.snowtide.pdf.annot
The com.snowtide.pdf.annot package contains interfaces and classes that PDFTextStream uses to represent various types of annotations present in PDF documents.
com.snowtide.pdf.forms - package com.snowtide.pdf.forms
The com.snowtide.pdf.forms package is home to a variety of classes that support PDFTextStream's form extraction functionality.
com.snowtide.pdf.layout - package com.snowtide.pdf.layout
 
com.snowtide.pdf.lucene - package com.snowtide.pdf.lucene
The com.snowtide.pdf.lucene package provides a method of seamless integration between the Apache Lucene full-text indexing and search engine available for the Java environment.
com.snowtide.pdf.util - package com.snowtide.pdf.util
 
com.snowtide.util.logging - package com.snowtide.util.logging
 
convertTablesToCSV(Page, char, String) - Static method in class com.snowtide.pdf.util.TableUtils
Returns an array of CSV-formatted Strings, one for each Table found in the given page, using the specified character as a cell delimiter and the specified String as a linebreak sequence.
convertTablesToCSV(Page, char) - Static method in class com.snowtide.pdf.util.TableUtils
Calls convertTablesToCSV(Page, char, String) with the specified page, cell delimiter, and a single linefeed (\n) as a linebreak sequence.
convertToCSV(Table, char) - Static method in class com.snowtide.pdf.util.TableUtils
Calls convertToCSV(Table, char, String) with the specified Table, cell delimiter, and a single linefeed (\n) as a linebreak sequence.
convertToCSV(Table, char, String) - Static method in class com.snowtide.pdf.util.TableUtils
Returns a CSV-formatted String based on the contents of the given Table, using the specified character as a cell delimiter and the specified String as a linebreak sequence.
copyAllPDFAttrs() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if this object is configured to ensure that all PDF document attributes will be added to generated Lucene Documents, even if no attribute name / field name mapping has been established in this config object.
crop(Region) - Method in interface com.snowtide.pdf.layout.Block
Returns a Block instance that contains only the content held by this Block instance that intersects the given "query" area.
crop(Region) - Method in interface com.snowtide.pdf.Page
Returns a Page instance that contains only the content held by this Page instance that intersects the given "query" area.

D

debug(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'debug' severity level.
debug(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'debug' severity level, including information about an associated Throwable.
DEFAULT_MAIN_TEXT_FIELD_NAME - Static variable in class com.snowtide.pdf.lucene.DocumentFactoryConfig
The default name assigned to the Lucene Field containing the main body of text extracted from a PDF file.
DEFAULT_UNSELECTED_VALUE - Static variable in class com.snowtide.pdf.forms.AcroButtonField
This String ("/Off") is the typical value associated with the unselected appearance for both checkboxes and radio buttons.
DocumentFactoryConfig - Class in com.snowtide.pdf.lucene
Instances of this class are used to control the creation of Lucene Documents from PDF content through the PDFDocumentFactory class.
DocumentFactoryConfig(String) - Constructor for class com.snowtide.pdf.lucene.DocumentFactoryConfig
Creates a new config object.
DocumentFactoryConfig() - Constructor for class com.snowtide.pdf.lucene.DocumentFactoryConfig
Creates a new config object.

E

EncryptedPDFException - Exception in com.snowtide.pdf
A subclass of IOException that is thrown by PDFTextStream constructors if one of the following conditions occurs: a variety of encryption is encountered that PDFTextStream does not support an error occurs while decrypting PDF data an incorrect password is provided to one of the PDFTextStream constructors
EncryptionInfo - Class in com.snowtide.pdf
Instances of this class provide information about the parameters used to encrypt a PDF document.
EncryptionInfo() - Constructor for class com.snowtide.pdf.EncryptionInfo
 
endBlock(Block) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream has finished processing a Block.
endBlock(Block) - Method in class pdfts.examples.XMLOutputTarget
 
endLine(Line) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream has finished processing a Line.
endLine(Line) - Method in class com.snowtide.pdf.VisualOutputTarget
 
endPage(Page) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream has finished processing a page
endPage(Page) - Method in class com.snowtide.pdf.OutputTarget
 
endPage(Page) - Method in class com.snowtide.pdf.RegionOutputTarget
 
endPage(Page) - Method in class com.snowtide.pdf.SelectionOutputTarget
 
endPage(Page) - Method in class com.snowtide.pdf.VisualOutputTarget
 
endPage(Page) - Method in class pdfts.examples.GoogleHTMLOutputHandler
 
endPage(Page) - Method in class pdfts.examples.XMLOutputTarget
 
endPDF(String, File) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream has finished processing a PDF.
endPDF(String, File) - Method in class pdfts.examples.XMLOutputTarget
 
endxpos() - Method in interface com.snowtide.pdf.layout.Region
 
endypos() - Method in interface com.snowtide.pdf.layout.Region
 
error(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'error' severity level.
error(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'error' severity level, including information about an associated Throwable.
ERROR_BAD_PASSWORD - Static variable in exception com.snowtide.pdf.EncryptedPDFException
Error type indicating that a PDFTextStream instance was created without a password when one was needed, or that the instance was created with an incorrect password.
ERROR_SECURITY_API_FAILURE - Static variable in exception com.snowtide.pdf.EncryptedPDFException
Error type indicating that the encrypted PDF could not be decrypted because of a failure of the current JDK's security implementation.
ERROR_SYNTAX - Static variable in exception com.snowtide.pdf.EncryptedPDFException
Error type indicating that a decryption parameter is either missing or has an invalid value.
ERROR_UNSPECIFIED - Static variable in exception com.snowtide.pdf.EncryptedPDFException
Error type indicating an unspecified encryption error.
ERROR_UNSUPPORTED - Static variable in exception com.snowtide.pdf.EncryptedPDFException
Error type indicating that a PDF file is encrypted using a method that is unsupported by the current version of PDFTextStream.
exportFormAsXML(PDFTextStream) - Static method in class pdfts.examples.XMLFormExport
Extracts all interactive form data from a PDF file using the given PDFTextStream, and returns a DOM XML Document instance containing the form data.
extract(PDFTextStream) - Static method in class com.snowtide.pdf.util.KodakPrintData
 

F

fatal(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'fatal' severity level.
fatal(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'fatal' severity level, including information about an associated Throwable.
FaultyPDFException - Exception in com.snowtide.pdf
Exceptions of this type are thrown by PDFTextStream when it encounters such a serious error when attempting to process a PDF file that no extraction can take place.
FaultyPDFException() - Constructor for exception com.snowtide.pdf.FaultyPDFException
 
FaultyPDFException(String) - Constructor for exception com.snowtide.pdf.FaultyPDFException
 
FIELD_TYPE_BUTTON - Static variable in interface com.snowtide.pdf.forms.AcroFormField
 
FIELD_TYPE_CHOICE - Static variable in interface com.snowtide.pdf.forms.AcroFormField
 
FIELD_TYPE_OTHER - Static variable in interface com.snowtide.pdf.forms.AcroFormField
 
FIELD_TYPE_SIGNATURE - Static variable in interface com.snowtide.pdf.forms.AcroFormField
 
FIELD_TYPE_TEXT - Static variable in interface com.snowtide.pdf.forms.AcroFormField
 
finalize() - Method in class com.snowtide.pdf.PDFTextStream
 
Font - Interface in com.snowtide.pdf
Represents a PDF font.
forBuffer(Appendable) - Static method in class com.snowtide.pdf.OutputTarget
Deprecated. use OutputTarget.OutputTarget(Appendable)
Form - Interface in com.snowtide.pdf.forms
Provides access to form data available in a PDF document.
FormField - Interface in com.snowtide.pdf.forms
Base interface for objects representing fields within a Form.
forWriter(Writer) - Static method in class com.snowtide.pdf.OutputTarget
Deprecated. use OutputTarget.OutputTarget(Writer) instead
FreeTextAnnotation - Class in com.snowtide.pdf.annot
An Annotation implementation that represents a PDF annotation of type FreeText.
FreeTextAnnotation() - Constructor for class com.snowtide.pdf.annot.FreeTextAnnotation
 

G

getAllAnnotations() - Method in class com.snowtide.pdf.PDFTextStream
Returns a list containing all of the annotations contained in the current PDF document.
getAllAnnotations(List) - Method in class com.snowtide.pdf.PDFTextStream
Adds to the given List all of the annotations contained in the current PDF document.
getAllChildren(List) - Method in class com.snowtide.pdf.Bookmark
Adds all of the direct descendants of this bookmark to the given list.
getAllChildren() - Method in class com.snowtide.pdf.Bookmark
Returns a new List of the direct descendants of this bookmark.
getAllDescendants(List) - Method in class com.snowtide.pdf.Bookmark
Performs a full descent of the bookmark tree rooted at this bookmark, adding all descendant child bookmarks to the given list.
getAllDescendants() - Method in class com.snowtide.pdf.Bookmark
Performs a full descent of the bookmark tree rooted at this bookmark, adding all descendant child bookmarks to a new list, which is returned.
getAllTables(Page) - Static method in class com.snowtide.pdf.util.TableUtils
Returns a List of Table instances that are available in the given Page.
getAnnotations(int) - Method in class com.snowtide.pdf.PDFTextStream
Returns a List of all annotations found on the page indicated by the given page number; each object will be an instance of a class that implements the Annotation interface.
getAttribute(String) - Method in class com.snowtide.pdf.PDFTextStream
This method is used to access all of the document-level metadata attributes that are set in a PDF document.
getAttributeKeys() - Method in class com.snowtide.pdf.PDFTextStream
Returns a Set containing the keys of all available document attributes.
getAttributeMap() - Method in class com.snowtide.pdf.PDFTextStream
Returns a Map containing a copy of all keys and values of all available document attributes.
getBitLength() - Method in class com.snowtide.pdf.EncryptionInfo
Returns the bit length of the key used to encrypt the document; will always be a multiple of 8, and between 40 - 128.
getBookmarks() - Method in class com.snowtide.pdf.PDFTextStream
If the current PDF document contains a bookmark tree, this function will return its root node.
getBottomBound() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the y-coordinate on the page to which this link annotation refers where a PDF viewer should position the bottom edge of its window when the link annotation is activated.
getBottomBound() - Method in class com.snowtide.pdf.Bookmark
Returns the y-coordinate on the page to which this bookmark refers where a PDF viewer should position the bottom edge of its window when the bookmark is activated.
getButtonType() - Method in class com.snowtide.pdf.forms.AcroButtonField
Returns an indicator of what type of button this field object represents.
getCharacterSequence() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns a character array indicating the characters that should be rendered for this TextUnit instead of the 'raw' character code provided by TextUnit.getCharCode().
getCharCode() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns the 'raw' character code used to encode this TextUnit in the source PDF document.
getCharSeqForCode(int) - Method in interface com.snowtide.pdf.Font
Returns the character sequence that corresponds to the given character code for this Font.
getCheckedValue() - Method in class com.snowtide.pdf.forms.AcroCheckboxField
Returns the value that represents the checked state for this checkbox.
getChild(int) - Method in class com.snowtide.pdf.Bookmark
Returns the n-th child of this bookmark.
getChild(int) - Method in interface com.snowtide.pdf.layout.BlockParent
Returns the child and the given index.
getChildCnt() - Method in class com.snowtide.pdf.Bookmark
Returns the number of children this bookmark contains.
getChildCnt() - Method in interface com.snowtide.pdf.layout.BlockParent
Returns the number of children held by this BlockParent.
getConfig() - Method in class com.snowtide.pdf.OutputTarget
Returns the PDFTextStreamConfig instance that this OutputTarget is currently using.
getConfig() - Method in interface com.snowtide.pdf.Page
Returns the PDFTextStreamConfig instance provided to this page by its parent PDFTextStream instance.
getConfig() - Method in class com.snowtide.pdf.PDFTextStream
Returns the PDFTextStreamConfig instance that this PDFTextStream instance is using to govern its operation.
getContents() - Method in interface com.snowtide.pdf.annot.Annotation
Returns the text content of this annotation.
getCropBox() - Method in interface com.snowtide.pdf.Page
The "crop box" defined by the PDF for this page, expressed in user space units as with Page.getPageHeight() and Page.getPageWidth().
getData() - Method in class com.snowtide.pdf.util.KodakPrintData
Returns the raw KDK print job data as extracted from the PDF document.
getDefaultConfig() - Static method in class com.snowtide.pdf.PDFTextStreamConfig
Returns the configuration that new PDFTextStream instances use by default (which is settable via PDFTextStreamConfig.setDefaultConfig(PDFTextStreamConfig).
getDefaultValue() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the default value to which the field reverts when a reset-form action is executed, as specified in the /DV entry in this field's PDF dictionary.
getDestinationName() - Method in class com.snowtide.pdf.Bookmark
Returns the name of the destination associated with this Bookmark.
getDisplayValue(String) - Method in class com.snowtide.pdf.forms.AcroChoiceField
Returns the display value associated with the supplied export value.
getEncryptionInfo() - Method in class com.snowtide.pdf.PDFTextStream
Returns an EncryptionInfo object, which provides access to some of the parameters used for the current PDF document's encryption.
getErrorType() - Method in exception com.snowtide.pdf.EncryptedPDFException
Returns an object indicating the type of error that caused this exception to be thrown.
getExportValue() - Method in class com.snowtide.pdf.forms.AcroButtonField
Returns the export value set on this button field.
getExportValue(String) - Method in class com.snowtide.pdf.forms.AcroChoiceField
 
getExportValues() - Method in class com.snowtide.pdf.forms.AcroButtonField
Returns a java.util.List of the possible export values of this button field, as dictated by the field dictionary's /Opt entry.
getField(String) - Method in interface com.snowtide.pdf.forms.AcroForm
Returns the AcroFormField that has the given field name, as provided by the AcroFormField.getFullName() function.
getField(String) - Method in interface com.snowtide.pdf.forms.Form
Returns the FormField held by this form with the given name.
getFieldName(String) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns the name that will be assigned to Fields containing the value of the PDF document attribute identified within the PDF document by the provided attribute name.
getFieldNames() - Method in interface com.snowtide.pdf.forms.AcroForm
Returns an Enumeration of the full field names (as provided by AcroFormField.getFullName()) of all of the form fields held by this form.
getFieldNames() - Method in interface com.snowtide.pdf.forms.Form
Returns an Enumeration of the field names of all of the fields held by this form.
getFilterName() - Method in class com.snowtide.pdf.EncryptionInfo
Returns the name of the security handler for the PDF document.
getFont() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns the Font that was in force when this textunit was outputted.
getFontName() - Method in interface com.snowtide.pdf.Font
Returns the name of this font as specified in the PDF file.
getFormData() - Method in class com.snowtide.pdf.PDFTextStream
Loads the form data contained in the current document, and returns a Form object that represents that data.
getFullName() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the fully-qualified name of this field, which should be unique within a PDF document form.
getHTMLDocument() - Method in class pdfts.examples.GoogleHTMLOutputHandler
Returns the XHTML document that is built up by this OutputHandler.
getIconName() - Method in class com.snowtide.pdf.annot.TextAnnotation
Returns an optional String attribute indicating the type of icon to be used in displaying this annotation.
getJustificationInd() - Method in class com.snowtide.pdf.annot.FreeTextAnnotation
Returns an int indicating how the text content of this annotation should be justified.
getLeftBound() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the x-coordinate on the page to which this link annotation refers where a PDF viewer should position the left edge of its window when the link annotation is activated.
getLeftBound() - Method in class com.snowtide.pdf.Bookmark
Returns the x-coordinate on the page to which this bookmark refers where a PDF viewer should position the left edge of its window when the bookmark is activated.
getLine(int) - Method in interface com.snowtide.pdf.layout.Block
Returns the Line at the given index.
getLinebreakString() - Method in class com.snowtide.pdf.PDFTextStreamConfig
Returns the string that OutputTarget (and its subclasses) output for each linebreak identified in extracted PDF content.
getLineCnt() - Method in interface com.snowtide.pdf.layout.Block
Returns the number of Lines held by this Block.
getLines() - Method in interface com.snowtide.pdf.layout.Block
Returns a List view of the Lines held by this Block.
getLinkActionName() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the name of the type of action that this link annotation will perform when a user activates it within a PDF viewer.
getLocalName() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the local name of the field, as specified in the /T entry in this field's PDF dictionary.
getLog(Class) - Method in interface com.snowtide.util.logging.LogFactory
Returns a Log instance specific to the specified class.
getLog(String) - Method in interface com.snowtide.util.logging.LogFactory
Returns a Log instance corresponding to the specified logger name.
getLog(Class) - Static method in class com.snowtide.util.logging.LoggingRegistry
Convenience method for retrieving a Log instance for the given Class from the current LogFactory.
getLog(String) - Static method in class com.snowtide.util.logging.LoggingRegistry
Convenience method for retrieving a Log instance with the given name from the current LogFactory.
getMainTextFieldName() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns the name that will be assigned to the field that holds the main body text of each PDF document converted into a Lucene Document instance through the PDFDocumentFactory class using this config object.
getMappingName() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the 'mapping name' of this field, as specified in the /TM entry in this field's PDF dictionary.
getMaxLength() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns the maximum length of this field, as specified by this form field's /MaxLen entry.
getMinTableCellCount() - Method in class com.snowtide.pdf.PDFTextStreamConfig
Returns the minimum number of adjacent cells that must be present in order for PDFTextStream to recognize those cells collectively as a Table.
getModificationDate() - Method in interface com.snowtide.pdf.annot.Annotation
Returns the date, in PDF date format, when this annotation was last modified.
getName() - Method in interface com.snowtide.pdf.annot.Annotation
Returns the optional name for this annotation, which should uniquely identify it within a page.
getName() - Method in interface com.snowtide.pdf.forms.FormField
Returns the canonical name of this field.
getName() - Method in class com.snowtide.pdf.PDFTextStream
Returns the name of the PDF that this stream is configured to read; this will be either the name of the PDF file that is being read, or the pdfName String that was provided if this instance was created with an InputStream constructor.
getObject() - Method in class com.snowtide.pdf.OutputTarget
Returns the output object that this instance wraps; will be an instance of either java.io.Writer or java.lang.Appendable.
getOptions() - Method in class com.snowtide.pdf.forms.AcroChoiceField
Returns a Map containing all of the options offered by this choice field, using export values (strings that can be returned by getValue()) as keys mapped to display values (strings that are returned by AcroChoiceField.getDisplayValue(String), given a valid export value).
getPage(int) - Method in class com.snowtide.pdf.PDFTextStream
Reads and returns a single page from the current PDF document.
getPageCnt() - Method in class com.snowtide.pdf.PDFTextStream
Returns the number of pages in the PDF document.
getPageHeight() - Method in interface com.snowtide.pdf.Page
Returns the height of this page in PDF "default user space units" (as specified by the PDF spec).
getPageNumber() - Method in interface com.snowtide.pdf.annot.Annotation
Returns the page with which this annotation is associated.
getPageNumber() - Method in class com.snowtide.pdf.Bookmark
Returns the page number for this bookmark.
getPageNumber() - Method in interface com.snowtide.pdf.Page
Returns this Page's page number.
getPageWidth() - Method in interface com.snowtide.pdf.Page
Returns the width of this page in PDF "default user space units" (as specified by the PDF spec).
getPDFFile() - Method in class com.snowtide.pdf.PDFTextStream
Returns a reference to the file that this PDFTextStream instance is processing.
getPdfFileSize() - Method in class com.snowtide.pdf.PDFTextStream
Returns the size of the PDF file being read, in bytes.
getPdfName() - Method in class com.snowtide.pdf.EncryptionInfo
Returns the name of the PDF document that this object is associated with.
getPdfName() - Method in interface com.snowtide.pdf.Page
Returns the name of the PDF document from which this Page was extracted.
getPDFVersion() - Method in class com.snowtide.pdf.PDFTextStream
Retrieves the PDFVersion instance that corresponds with the version of the PDF file specification to which current PDF file adheres.
getPossibleValues() - Method in class com.snowtide.pdf.forms.AcroRadioButtonGroupField
Returns a set of the possible values that may be set on this button.
getPreviousURI() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the previous URI to which this link annotation referred.
getRect() - Method in interface com.snowtide.pdf.annot.Annotation
Returns the bounding rectangle where this annotation is located on its page.
getRegionCnt() - Method in class com.snowtide.pdf.RegionOutputTarget
Returns the number of registered regions.
getRegionNames() - Method in class com.snowtide.pdf.RegionOutputTarget
Returns a set containing each of the names used to register regions on this RegionOutputTarget via RegionOutputTarget.addRegion(float, float, float, float, String).
getRegionText(int) - Method in class com.snowtide.pdf.RegionOutputTarget
Returns the text extracted from the i-th region that was registered with this RegionOutputTarget.
getRegionText(String) - Method in class com.snowtide.pdf.RegionOutputTarget
Returns the text extracted from the region that was registered with this RegionOutputTarget using the provided name.
getRichContent() - Method in class com.snowtide.pdf.annot.FreeTextAnnotation
Returns the rich text content held by this annotation.
getRichContentStyle() - Method in class com.snowtide.pdf.annot.FreeTextAnnotation
Returns the CSS style information held by this annotation that should be applied to the rich text content returned by the FreeTextAnnotation.getRichContent() function when that content is displayed.
getRichTextValue() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns the 'rich text' value for this field (XHTML that conforms to the XFA specification), if available.
getRightBound() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the x-coordinate on the page to which this link annotation refers where a PDF viewer should position the right edge of its window when the link annotation is activated.
getRightBound() - Method in class com.snowtide.pdf.Bookmark
Returns the x-coordinate on the page to which this bookmark refers where a PDF viewer should position the right edge of its window when the bookmark is activated.
getRotationTheta() - Method in interface com.snowtide.pdf.Page
Returns the number of degrees by which the page has been rotated clockwise.
getRow(int) - Method in interface com.snowtide.pdf.layout.Table
Returns a BlockParent instance containing the Blocks that form the indicated row number.
getRowCnt() - Method in interface com.snowtide.pdf.layout.Table
Returns the number of rows in this table.
getSpacingScale() - Method in class com.snowtide.pdf.VisualOutputTarget
Returns the spacing scale currently in effect for this VisualOutputTarget.
getStream() - Method in interface com.snowtide.pdf.Page
Returns the PDFTextStream instance from which this Page was sourced.
getStreamFilter() - Method in class com.snowtide.pdf.EncryptionInfo
 
getStringFilter() - Method in class com.snowtide.pdf.EncryptionInfo
 
getSubfilterName() - Method in class com.snowtide.pdf.EncryptionInfo
 
getTargetPageNumber() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the page number to which this link annotation refers.
getTextContent() - Method in interface com.snowtide.pdf.Page
Returns a BlockParent instance that contains all Block instances held by this Page, which in turn hold all text content for this Page.
getTextUnit(int) - Method in interface com.snowtide.pdf.layout.Line
Returns the TextUnit at the specified index.
getTextUnitCnt() - Method in interface com.snowtide.pdf.layout.Line
Returns the number of TextUnits in this Line.
getTextUnits() - Method in interface com.snowtide.pdf.layout.Line
Returns a List view of the TextUnits held by this Line.
getTheta() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns the angle (in degrees) by which this TextUnit's baseline is rotated.
getTitle() - Method in class com.snowtide.pdf.Bookmark
Returns the title/label for this bookmark.
getTopBound() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the y-coordinate on the page to which this link annotation refers where a PDF viewer should position the top edge of its window when the link annotation is activated.
getTopBound() - Method in class com.snowtide.pdf.Bookmark
Returns the y-coordinate on the page to which this bookmark refers where a PDF viewer should position the top edge of its window when the bookmark is activated.
getType() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the type of field, as specified in the /FT entry in this field's PDF dictionary.
getTypeCd() - Method in interface com.snowtide.pdf.annot.Annotation
Returns a String indicating what type of annotation this this.
getUIName() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the user-friendly name of this field, as specified in the /TU entry in this field's PDF dictionary.
getUIName() - Method in interface com.snowtide.pdf.forms.FormField
Returns a user-friendly name for this field, typically used to identify the field to users or in extracts of form data.
getURI() - Method in class com.snowtide.pdf.annot.LinkAnnotation
Returns the URI to which this link annotation refers; this will be non-null only if this link's annotation action type is 'URI'.
getV() - Method in class com.snowtide.pdf.EncryptionInfo
Returns the algorithm "version" used when the document was encrypted.
getValue() - Method in class com.snowtide.pdf.forms.AcroButtonField
Returns this button's 'base value', which is actually a code used by a PDF viewer to determine how to draw a button's widget.
getValue() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns the value of this field, as specified in the /V entry in this field's PDF dictionary.
getValue() - Method in interface com.snowtide.pdf.forms.FormField
Returns the current value of the field.
getVersionInd() - Method in class com.snowtide.pdf.PDFVersion
Returns the version indicator ('1.1', '1.2', etc).
getWidgetType() - Method in class com.snowtide.pdf.forms.AcroChoiceField
Returns either AcroChoiceField.CHOICE_TYPE_COMBO (indicating that this choice widget is a dropdown, single-selection field), or AcroChoiceField.CHOICE_TYPE_LIST, indicating that this choice widget is a multiple-row, possibly multiple-selection field).
getXFAContents() - Method in interface com.snowtide.pdf.forms.AcroForm
Returns the entire XFA contents of this form.
getXFAPacketContents(String) - Method in interface com.snowtide.pdf.forms.AcroForm
Returns the contents of the XML element referenced by packetName in this form.
getXFAPacketNames() - Method in interface com.snowtide.pdf.forms.AcroForm
Returns a Set of the packet names of the XFA data.
getXMLAsString() - Method in class pdfts.examples.XMLOutputTarget
Returns the XML built by this XMLOutputTarget as a String.
getXMLDocument() - Method in class pdfts.examples.XMLOutputTarget
Returns the DOM Document that this XMLOutputTarget is building.
getXmlMetadata() - Method in class com.snowtide.pdf.PDFTextStream
Returns the XML metadata available for the current PDF document.
GoogleHTMLOutputHandler - Class in pdfts.examples
This example captures PDF text content, and builds an XHTML document to mimic the HTML view that Google offers for indexed PDF documents.
GoogleHTMLOutputHandler() - Constructor for class pdfts.examples.GoogleHTMLOutputHandler
 

H

hasRichTextValue() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns true only if the value of this field is 'rich text' (XHTML that conforms to the XFA specification), which may be retrieved via the AcroTextField.getRichTextValue() function.
hasValueChanged() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns true only if this field's value has been changed since being loaded from the PDF document.
height() - Method in interface com.snowtide.pdf.layout.Region
 

I

indexMainText() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the main body text of Lucene Documents created through PDFDocumentFactory using this config object will be indexed.
indexPDFAttrs() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the metadata attributes of Lucene Documents created through PDFDocumentFactory using this config object will be indexed.
info(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'info' severity level.
info(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'info' severity level, including information about an associated Throwable.
isBold() - Method in interface com.snowtide.pdf.Font
Returns true if this font is bold.
isChecked() - Method in class com.snowtide.pdf.forms.AcroCheckboxField
Returns true only if this checkbox is checked (i.e.
isCJKSupportEnabled() - Static method in class com.snowtide.pdf.PDFTextStreamConfig
Returns true if this configuration will cause PDFTextStream to extract and decode Chinese, Japanese, and Korean content.
isDebugEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'debug' logging severity level is enabled.
isDeriveType3Fonts() - Method in class com.snowtide.pdf.PDFTextStreamConfig
Returns true if this configuration will cause PDFTextStream to derive the Unicode encodings of Type3 PDF fonts.
isEditable() - Method in class com.snowtide.pdf.forms.AcroChoiceField
Returns true if this field is user-editable, indicating that a user may set this field's value to a arbitrary character string.
isErrorEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'error' logging severity level is enabled.
isFatalEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'fatal' logging severity level is enabled.
isFileSelection() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns true if this is field is designated to hold the path of a user-selected file.
isImplicitLineDetectionEnabled() - Method in class com.snowtide.pdf.PDFTextStreamConfig
 
isIncludingRotatedChars() - Method in class com.snowtide.pdf.VisualOutputTarget
Return true if this VisualOutputTarget will include rotated TextUnits in its output (true by default).
isInfoEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'info' logging severity level is enabled.
isItalic() - Method in interface com.snowtide.pdf.Font
Returns true if this font is italic.
isLicensed() - Static method in class com.snowtide.pdf.PDFTextStream
Returns true if PDFTextStream has loaded and verified a non-evaluation license file that has not yet expired.
isMemoryMappingEnabled() - Method in class com.snowtide.pdf.PDFTextStreamConfig
Deprecated. Memory-mapping of opened PDF files is disabled by default, and will be removed as an option in future PDFTextStream releases.
isMultiline() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns true if this is a multiline text field.
isPasswordEntry() - Method in class com.snowtide.pdf.forms.AcroTextField
Returns true if this is a password-entry text field.
isReadOnly() - Method in interface com.snowtide.pdf.forms.AcroFormField
Returns true only if this field is designated as read-only.
isStripXFAFormDataEnabled() - Method in class com.snowtide.pdf.PDFTextStreamConfig
 
isStruckThrough() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns true if this TextUnit is struck through.
isTraceEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'trace' logging severity level is enabled.
isUnderlined() - Method in interface com.snowtide.pdf.layout.TextUnit
Returns true if this TextUnit is underlined.
isWarnEnabled() - Method in interface com.snowtide.util.logging.Log
Returns true if the 'warn' logging severity level is enabled.
iterator() - Method in interface com.snowtide.pdf.forms.Form
Returns an Iterator that iterates over all of the FormField instances held by this Form.

K

KodakPrintData - Class in com.snowtide.pdf.util
This class extracts Kodak print job data (%KDK commands).

L

Line - Interface in com.snowtide.pdf.layout
Instances of this class represent distinct runs of text at a specific position within a Block.
linebreaks(int) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream determines that a series of line breaks should be outputted between the previous entity (page, block, line, etc) and the next entity (page, block, line, etc).
linebreaks(int) - Method in class com.snowtide.pdf.OutputTarget
Default implementation that writes specified number of line breaks (using the linebreak String provided by the current configuration) to the java.io.Writer or java.lang.Appendable object that this OutputTarget wraps.
linebreaks(int) - Method in class com.snowtide.pdf.VisualOutputTarget
 
linebreaks(int) - Method in class pdfts.examples.XMLOutputTarget
 
LinkAnnotation - Class in com.snowtide.pdf.annot
An Annotation implementation that represents a PDF annotation of type Link.
LinkAnnotation() - Constructor for class com.snowtide.pdf.annot.LinkAnnotation
 
loadLicense(String) - Static method in class com.snowtide.pdf.PDFTextStream
Loads and attempts to verify a PDFTextStream license file at the given path.
loadLicense(URL) - Static method in class com.snowtide.pdf.PDFTextStream
Loads and attempts to verify a PDFTextStream license file at the given URL.
Log - Interface in com.snowtide.util.logging
Interface that must be implemented the loggers returned by any LogFactory implementation.
LogFactory - Interface in com.snowtide.util.logging
Custom logging implementations that are to be used by PDFTextStream (and therefore registered with the LoggingRegistry class) must implement this interface.
LoggingRegistry - Class in com.snowtide.util.logging
This class is provided to allow applications that use PDFTextStream to supply custom logging implementations.

M

main(String[]) - Static method in class com.snowtide.pdf.PDFTextStream
Main-method to allow extraction of text from a PDF file from the command line.
main(String[]) - Static method in class com.snowtide.pdf.util.MergeUtil
Deprecated. Command-line interface to PDF merge functionality.
main(String[]) - Static method in class pdfts.examples.GoogleHTMLOutputHandler
Main method for command-line execution.
main(String[]) - Static method in class pdfts.examples.XMLFormExport
Exports the form data held in the PDF file referenced by the first path to a new XML document referenced by the second path.
main(String[]) - Static method in class pdfts.examples.XMLOutputTarget
A main method suitable for using this class' functionality from the command line.
mergeDocuments(File[], File) - Static method in class com.snowtide.pdf.util.MergeUtil
Deprecated. Merges a series of PDF files into a single PDF document, and writes the merged document data to the given file path.
mergeDocuments(File[], OutputStream) - Static method in class com.snowtide.pdf.util.MergeUtil
Deprecated. Merges a series of PDF files into a single PDF document, and writes the merged document data to the given OutputStream.
MergeUtil - Class in com.snowtide.pdf.util
Deprecated. Merge functionality may be removed in a future PDFTextStream release

O

OutputHandler - Class in com.snowtide.pdf
The base class for all PDF text event handlers.
OutputHandler() - Constructor for class com.snowtide.pdf.OutputHandler
 
OutputTarget - Class in com.snowtide.pdf
This is a base OutputHandler implementation that provides a common output interface for Writer and Appendable instances (such as StringBuilders and StringBuffers), allowing PDFTextStream to easily redirect output to either type of object.
OutputTarget(Writer) - Constructor for class com.snowtide.pdf.OutputTarget
Creates a new OutputTarget that directs output to the given java.io.Writer instance.
OutputTarget(Appendable) - Constructor for class com.snowtide.pdf.OutputTarget
Creates a new OutputTarget that directs output to the given java.lang.Appendable instance.

P

Page - Interface in com.snowtide.pdf
Instances of this class provide access to the text and attributes of a page extracted from a PDF document.
parseDateString(String) - Static method in class com.snowtide.pdf.PDFDateParser
Parses the provided PDF-format date string into a java.util.Date instance.
pdfAttrNames() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns a Set of the PDF document attribute names that are mapped to Field names in this config object.
PDFDateParser - Class in com.snowtide.pdf
This class provides methods for parsing PDF-format date/time strings into java.util.Date objects.
PDFDocumentFactory - Class in com.snowtide.pdf.lucene
This class allows the functionality of PDFTextStream to be dropped into a Lucene environment seamlessly (versions 1.2, 1.3, 1.4, 1.9, 2.0, 2.1, and 2.2 of Lucene are supported; a corresponding Lucene library jar must be any application's classpath that needs to use this class).
PDFDocumentFactory() - Constructor for class com.snowtide.pdf.lucene.PDFDocumentFactory
 
PDFTextStream - Class in com.snowtide.pdf
PDFTextStream gives your Java, .NET, and Python applications the ability to: Extract text and metadata from PDF documents (including metadata like XMP data, bookmarks, and annotations) Extract and update interactive AcroForm data Merge PDF documents Instances of this class can either access a PDF file directly, or process equivalent data delivered via a java.io.InputStream or java.nio.ByteBuffer.
PDFTextStream(InputStream, String) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given InputStream.
PDFTextStream(File) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given File.
PDFTextStream(String) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from a file located at the given path.
PDFTextStream(InputStream, String, byte[], PDFTextStreamConfig) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given InputStream.
PDFTextStream(InputStream, String, byte[]) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given InputStream.
PDFTextStream(File, byte[], PDFTextStreamConfig) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given File.
PDFTextStream(String, byte[], PDFTextStreamConfig) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the file located at the given path.
PDFTextStream(File, byte[]) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given File.
PDFTextStream(String, byte[]) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given file at the given path.
PDFTextStream(ByteBuffer, String, byte[], PDFTextStreamConfig) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given ByteBuffer.
PDFTextStream(ByteBuffer, String, byte[]) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given ByteBuffer.
PDFTextStream(ByteBuffer, String) - Constructor for class com.snowtide.pdf.PDFTextStream
Creates a new PDFTextStream that reads PDF content from the given ByteBuffer.
PDFTextStreamConfig - Class in com.snowtide.pdf
Various configuration options for PDFTextStream may be set using this class.
PDFTextStreamConfig(PDFTextStreamConfig) - Constructor for class com.snowtide.pdf.PDFTextStreamConfig
Creates a copy of the given PDFTextStreamConfig instance.
PDFTextStreamConfig() - Constructor for class com.snowtide.pdf.PDFTextStreamConfig
 
pdfts.examples - package pdfts.examples
 
PDFVersion - Class in com.snowtide.pdf
A typesafe enumeration class that provides singleton objects corresponding to each possible PDFVersion instance that might be returned by calls to PDFTextStream.getPDFVersion().
pipe(OutputHandler) - Method in interface com.snowtide.pdf.layout.Block
Sends all text events associated with this Block to the given OutputHandler.
pipe(OutputHandler) - Method in interface com.snowtide.pdf.layout.Line
Sends all text events associated with this Line to the given OutputHandler.
pipe(OutputHandler) - Method in interface com.snowtide.pdf.Page
Extracts all text from this page, sending necessary events to the given OutputHandler implementation.
pipe(OutputHandler) - Method in class com.snowtide.pdf.PDFTextStream
Extracts all available text from this PDFTextStream instance, sending all PDF text events to the given OutputHandler.

R

read() - Method in class com.snowtide.pdf.PDFTextStream
 
read(char[]) - Method in class com.snowtide.pdf.PDFTextStream
 
read(char[], int, int) - Method in class com.snowtide.pdf.PDFTextStream
 
Rectangle - Interface in com.snowtide.pdf.layout
Representation of a single graphical rectangle.
Region - Interface in com.snowtide.pdf.layout
Classes that implement this interface represent spatial entities on a page.
RegionOutputTarget - Class in com.snowtide.pdf
This OutputHandler implemenation is used to selectively extract text from certain regions of each PDF page.
RegionOutputTarget() - Constructor for class com.snowtide.pdf.RegionOutputTarget
Creates a new RegionOutputTarget, using a VisualOutputTarget to lay out the text extracted for each region.
RegionOutputTarget(boolean) - Constructor for class com.snowtide.pdf.RegionOutputTarget
Creates a new RegionOutputTarget.
registerFactory(LogFactory) - Static method in class com.snowtide.util.logging.LoggingRegistry
Registers the given LogFactory instance as the designated LogFactory implementation for creating Log objects.
remove(int) - Method in interface com.snowtide.pdf.layout.Line
Removes the TextUnit at the specified index, and returns it.
removeAllChildren() - Method in interface com.snowtide.pdf.layout.BlockParent
 
removeChild(int) - Method in interface com.snowtide.pdf.layout.BlockParent
Removes and returns the child at the given index.
removeLine(int) - Method in interface com.snowtide.pdf.layout.Block
Removes the Line at the given index from this Block, and returns it.

S

SelectionOutputTarget - Class in com.snowtide.pdf
An OutputTarget derivative that restricts the content added to the given StringBuffer to that within the starting and ending selection points specified in the constructor.
SelectionOutputTarget(StringBuffer, float, float, float, float) - Constructor for class com.snowtide.pdf.SelectionOutputTarget
 
serializeXMLDocument(Document, Writer) - Static method in class pdfts.examples.XMLFormExport
Writes the given Document to the given Writer using a no-op XSL transformation.
setCJKSupportEnabled(boolean) - Static method in class com.snowtide.pdf.PDFTextStreamConfig
Changes the setting that controls whether or not PDFTextStream extracts and decodes Chinese, Japanese, and Korean content.
setConfig(PDFTextStreamConfig) - Method in class com.snowtide.pdf.OutputTarget
Sets the PDFTextStreamConfig instance this OutputTarget should use.
setConfig(PDFTextStreamConfig) - Method in class com.snowtide.pdf.PDFTextStream
Sets the PDFTextStreamConfig instance that this PDFTextStream instance will use in various contexts to govern its operation.
setCopyAllPDFAttrs(boolean) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Setter corresponding to the copyAllPDFAttrs attribute.
setDefaultConfig(PDFTextStreamConfig) - Static method in class com.snowtide.pdf.PDFTextStreamConfig
Sets the configuration that new PDFTextStream instances use by default.
setDeriveType3Fonts(boolean) - Method in class com.snowtide.pdf.PDFTextStreamConfig
Changes the setting that controls whether or not PDFTextStream derives the Unicode encodings of Type3 PDF fonts.
setFieldName(String, String) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Sets the name that will be assigned to Fields corresponding to the provided PDF document attribute name.
setImplicitLineDetectionEnabled(boolean) - Method in class com.snowtide.pdf.PDFTextStreamConfig
 
setIncludingRotatedChars(boolean) - Method in class com.snowtide.pdf.VisualOutputTarget
Used to set whether or not this VisualOutputTarget will include rotated TextUnits in its output (true by default).
setLinebreakString(String) - Method in class com.snowtide.pdf.PDFTextStreamConfig
Sets the string that OutputTarget (and its subclasses) output for each linebreak identified in extracted PDF content.
setMainTextFieldName(String) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Sets the name that will be assigned to Lucene Fields containing the main text content of PDF's converted to Lucene Documents via the PDFDocumentFactory class.
setMemoryMappingEnabled(boolean) - Method in class com.snowtide.pdf.PDFTextStreamConfig
Deprecated. Memory-mapping of opened PDF files is disabled by default, and will be removed as an option in future PDFTextStream releases.
setMinTableCellCount(int) - Method in class com.snowtide.pdf.PDFTextStreamConfig
Changes the setting that controls the minimum number of adjacent cells that must be present in order for PDFTextStream to recognize those cells collectively as a Table.
setPDFAttrSettings(boolean, boolean, boolean) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Sets Field attributes that will be used when creating Field objects for the document attributes found in a PDF document.
setSpacingScale(float) - Method in class com.snowtide.pdf.VisualOutputTarget
Modifies the spacing scale that is used when outputting content laid out using this VisualOutputTarget.
setStreamFilter(CryptFilter) - Method in class com.snowtide.pdf.EncryptionInfo
 
setStringFilter(CryptFilter) - Method in class com.snowtide.pdf.EncryptionInfo
 
setStripXFAFormDataEnabled(boolean) - Method in class com.snowtide.pdf.PDFTextStreamConfig
 
setTextSettings(boolean, boolean, boolean) - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Sets Field attributes that will be used when creating the Field object for the main text content of a PDF document.
setValue(boolean) - Method in class com.snowtide.pdf.forms.AcroCheckboxField
Sets the value of this checkbox field to be checked (true) or unchecked (false).
setValue(String) - Method in class com.snowtide.pdf.forms.AcroCheckboxField
Sets the value of this checkbox directly.
setValue(String) - Method in class com.snowtide.pdf.forms.AcroChoiceField
Updates this choice field's value so that the option corresponding with the single specified String is selected.
setValue(String[]) - Method in class com.snowtide.pdf.forms.AcroChoiceField
Updates this choice field's value so that each of the options corresponding with the Strings in the specified array are selected.
setValue(String) - Method in interface com.snowtide.pdf.forms.AcroFormField
Sets the value of this form field.
setValue(String) - Method in class com.snowtide.pdf.forms.AcroRadioButtonGroupField
Sets the value of this button field.
setValue(String) - Method in class com.snowtide.pdf.forms.AcroTextField
Sets the value of this text field.
sortChildren(Comparator) - Method in interface com.snowtide.pdf.layout.BlockParent
 
spaces(int) - Method in class com.snowtide.pdf.OutputHandler
Invoked when PDFTextStream determines that a series of spaces should be outputted between the previous entity (block, line, text unit, etc) and the next entity (block, line, text unit, etc).
spaces(int) - Method in class com.snowtide.pdf.OutputTarget
Default implementation that writes specified number of spaces to the java.io.Writer or java.lang.Appendable object that this OutputTarget wraps.
spaces(int) - Method in class com.snowtide.pdf.VisualOutputTarget
 
spaces(int) - Method in class pdfts.examples.XMLOutputTarget
 
startBlock(Block) - Method in class com.snowtide.pdf.OutputHandler
Invoked when a Block is about to be processed.
startBlock(Block) - Method in class com.snowtide.pdf.VisualOutputTarget
 
startBlock(Block) - Method in class pdfts.examples.XMLOutputTarget
 
startLine(Line) - Method in class com.snowtide.pdf.OutputHandler
Invoked when a Line is about to be processed.
startLine(Line) - Method in class com.snowtide.pdf.VisualOutputTarget
 
startPage(Page) - Method in class com.snowtide.pdf.OutputHandler
Invoked when a page is about to be processed.
startPage(Page) - Method in class com.snowtide.pdf.OutputTarget
 
startPage(Page) - Method in class com.snowtide.pdf.RegionOutputTarget
 
startPage(Page) - Method in class com.snowtide.pdf.SelectionOutputTarget
 
startPage(Page) - Method in class com.snowtide.pdf.VisualOutputTarget
 
startPage(Page) - Method in class pdfts.examples.GoogleHTMLOutputHandler
 
startPage(Page) - Method in class pdfts.examples.XMLOutputTarget
 
startPDF(String, File) - Method in class com.snowtide.pdf.OutputHandler
Invoked when a new PDF is about to be processed.
startPDF(String, File) - Method in class pdfts.examples.GoogleHTMLOutputHandler
 
startPDF(String, File) - Method in class pdfts.examples.XMLOutputTarget
 
storeMainText() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the main body text of Lucene Documents created through PDFDocumentFactory using this config object will be stored.
storePDFAttrs() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the metadata attributes of Lucene Documents created through PDFDocumentFactory using this config object will be stored.

T

Table - Interface in com.snowtide.pdf.layout
Blocks of this subtype have been recognized by PDFTextStream to contain a table-like structure.
TableUtils - Class in com.snowtide.pdf.util
This class provides a set of utility functions related to working with Tables.
TextAnnotation - Class in com.snowtide.pdf.annot
An Annotation implementation that represents a PDF annotation of type Text.
TextAnnotation() - Constructor for class com.snowtide.pdf.annot.TextAnnotation
 
TextUnit - Interface in com.snowtide.pdf.layout
A single character or discrete character grouping positioned within a Line.
textUnit(TextUnit) - Method in class com.snowtide.pdf.OutputHandler
Invoked when a run of characters is to be outputted, as represented by the given TextUnit instance.
textUnit(TextUnit) - Method in class com.snowtide.pdf.OutputTarget
Default implementation that writes the character run specified by the given TextUnit instance to the java.io.Writer or java.lang.Appendable object that this OutputTarget wraps.
textUnit(TextUnit) - Method in class com.snowtide.pdf.RegionOutputTarget
 
textUnit(TextUnit) - Method in class com.snowtide.pdf.SelectionOutputTarget
 
textUnit(TextUnit) - Method in class com.snowtide.pdf.VisualOutputTarget
 
textUnit(TextUnit) - Method in class pdfts.examples.GoogleHTMLOutputHandler
 
textUnit(TextUnit) - Method in class pdfts.examples.XMLOutputTarget
 
tokenizeMainText() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the main body text of Lucene Documents created through PDFDocumentFactory using this config object will be tokenized.
tokenizePDFAttrs() - Method in class com.snowtide.pdf.lucene.DocumentFactoryConfig
Returns true if the metadata attributes of Lucene Documents created through PDFDocumentFactory using this config object will be tokenized.
toString() - Method in exception com.snowtide.pdf.EncryptedPDFException
 
toString() - Method in class com.snowtide.pdf.PDFTextStreamConfig
 
toString() - Method in class com.snowtide.pdf.PDFVersion
 
trace(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'trace' severity level.
trace(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'trace' severity level, including information about an associated Throwable.

V

VERSION_1_0 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_1 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_2 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_3 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_4 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_5 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_6 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_1_7 - Static variable in class com.snowtide.pdf.PDFVersion
 
VERSION_OTHER - Static variable in class com.snowtide.pdf.PDFVersion
 
VisualOutputTarget - Class in com.snowtide.pdf
This OutputHandler implementation aims to preserve as much of a PDF's text layout as possible so that text extracts yielded by this OutputHandler will retain the visual arrangement of text as present in the original document.
VisualOutputTarget(Writer) - Constructor for class com.snowtide.pdf.VisualOutputTarget
 
VisualOutputTarget(Appendable) - Constructor for class com.snowtide.pdf.VisualOutputTarget
 

W

warn(Object) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'warn' severity level.
warn(Object, Throwable) - Method in interface com.snowtide.util.logging.Log
Output a logging message at the 'warn' severity level, including information about an associated Throwable.
width() - Method in interface com.snowtide.pdf.layout.Region
 
write(String) - Method in class com.snowtide.pdf.OutputTarget
Writes the provided String's character data to the wrapped output object.
write(CharSequence) - Method in class com.snowtide.pdf.OutputTarget
Writes the provided CharSequence's character data to the wrapped output object.
write(char[], int, int) - Method in class com.snowtide.pdf.OutputTarget
Writes the provided character data to the wrapped output object.
write(char[]) - Method in class com.snowtide.pdf.OutputTarget
Writes the provided character data to the wrapped output object.
write(char) - Method in class com.snowtide.pdf.OutputTarget
Writes the provided character to the wrapped output object.
writeUpdatedDocument(File) - Method in interface com.snowtide.pdf.forms.AcroForm
Identical functionality to AcroForm.writeUpdatedDocument(OutputStream), except the PDF document data is written to the path specified by the given File object.
writeUpdatedDocument(OutputStream) - Method in interface com.snowtide.pdf.forms.AcroForm
If any field values contained in this form have been changed, then this function writes a copy of the PDF document from which this form was read to the given OutputStream, and appends the updated form field values.

X

XMLFormExport - Class in pdfts.examples
This class extracts all interactive form data from a PDFTextStream instance (or from a PDF file specified via command line), and builds up an XML DOM Document instance containing the extracted form data.
XMLOutputTarget - Class in pdfts.examples
This class is an example OutputHandler implementation that builds up a DOM XML model of extracted PDF content.
XMLOutputTarget() - Constructor for class pdfts.examples.XMLOutputTarget
Creates a new XMLOutputTarget.
xpos() - Method in interface com.snowtide.pdf.layout.Region
 

Y

ypos() - Method in interface com.snowtide.pdf.layout.Region
 

A B C D E F G H I K L M O P R S T V W X Y