org.faceless.pdf2.viewer2.feature
Class PDFImporter

java.lang.Object
  org.faceless.pdf2.viewer2.ViewerFeature
      org.faceless.pdf2.viewer2.Importer
          org.faceless.pdf2.viewer2.feature.PDFImporter

public class PDFImporter
extends Importer

A subclass of Importer that allows PDF files to be loaded into the viewer. This feature is essential for regular operation of the Viewer - if not included in the list of features passed into the PDFViewer constructor, it will be added automatically.

To customize the list of EncryptionHandlers used when loading a PDF, this class can be altered. For example, to always use a specific password when loading a PDF you could do the following.

 // First, get rid of the default PDFImporter from the list
 Collection features = new ArrayList(ViewerFeature.getDefaultFeatures());
 for (Iterator i = features.iterator();i.hasNext();) {
     if (i.next() instanceof PDFImporter) {
         i.remove();
     }
 }

 // Next, create a new PDFImporter and set its EncryptionHandler
 PDFImporter importer = new PDFImporter();
 Set handlers = importer.getEncryptionHandlers();
 handlers.clear();
 StandardEncryptionHandler pwhandler = new StandardEncryptionHandler();
 pwhandler.setUserPassword("secret");
 handlers.add(pwhandler);

 // Add that feature to the list and pass it into the PDFViewer
 features.add(importer);
 PDFViewer viewer = new PDFViewer(features);
 

This code is copyright the Big Faceless Organization. You're welcome to use, modify and distribute it in any form in your own projects, provided those projects continue to make use of the Big Faceless PDF library.

Since:

2.10.2

Nested Class Summary

Nested classes/interfaces inherited from class org.faceless.pdf2.viewer2.Importer

Importer.ImporterTask

Constructor Summary

PDFImporter()
Create a new PDFImporter

Method Summary

Set	getEncryptionHandlers() Return the set of EncryptionHandler objects used to possibly decrypt PDF files loaded with this Importer.
FileFilter	getFileFilter() Get a FileFilter that can be used to choose files acceptable to this Importer.
Importer.ImporterTask	getImporter(PDFViewer viewer, File file) Return an Importer.ImporterTask that will load a PDF into the viewer from the specifed File.
Importer.ImporterTask	getImporter(PDFViewer viewer, InputStream in, String title, File file) Return an Importer.ImporterTask that will load a PDF into the viewer from the specifed InputStream.
void	initialize(PDFViewer viewer) Called when the feature is first added to a viewer
boolean	matches(File file) Return true if this Importer can load the specified file.

Methods inherited from class org.faceless.pdf2.viewer2.Importer

getImporter

Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature

getAllFeatures, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFImporter

public PDFImporter()

Create a new PDFImporter

Method Detail

initialize

public void initialize(PDFViewer viewer)

Description copied from class: ViewerFeature

Called when the feature is first added to a viewer

Overrides:

initialize in class ViewerFeature

getFileFilter

public FileFilter getFileFilter()

Description copied from class: Importer

Get a FileFilter that can be used to choose files acceptable to this Importer.

Specified by:

getFileFilter in class Importer

matches

public boolean matches(File file)
                throws IOException

Description copied from class: Importer

Return true if this Importer can load the specified file.

Specified by:

matches in class Importer

Parameters:

file - the File to be checked.

Returns:

true if this file can be loaded by this Importer, false otherwise

Throws:

IOException

getEncryptionHandlers

public Set getEncryptionHandlers()

Return the set of EncryptionHandler objects used to possibly decrypt PDF files loaded with this Importer. This set may be altered.

getImporter

public Importer.ImporterTask getImporter(PDFViewer viewer,
                                         File file)

Description copied from class: Importer

Return an Importer.ImporterTask that will load a PDF into the viewer from the specifed File.

Specified by:

getImporter in class Importer

Parameters:

viewer - the PDFViewer

file - the FILE to load the PDF from

Returns:

an Importer.ImporterTask to load the PDF

getImporter

public Importer.ImporterTask getImporter(PDFViewer viewer,
                                         InputStream in,
                                         String title,
                                         File file)

Description copied from class: Importer

Return an Importer.ImporterTask that will load a PDF into the viewer from the specifed InputStream.

Specified by:

getImporter in class Importer

Parameters:

viewer - the PDFViewer

in - the InputStream to load the PDF from

title - the title to give that PDF - may be null

file - if the PDF is later saved, the file to initialize the path to - may be null.

Returns:

an Importer.ImporterTask to load the PDF