org.faceless.pdf2.viewer2
Class Importer.ImporterTask

java.lang.Object
  extended by LongRunningTask
      extended by org.faceless.pdf2.viewer2.Importer.ImporterTask
Enclosing class:
Importer

public abstract class Importer.ImporterTask
extends LongRunningTask

This class is a LongRunningTask that can be run to load a PDF into the viewer. Subclasses of Importer need to implement a concrete subclass of this which implemented the loadPDF() method. By default this task is cancellable, but that may be overridden too.

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

Field Summary
protected  File file
          The file passed to the constructor
protected  InputStream in
          The InputStream passed to the constructor
protected  int pagenumber
          The initial pagenumber to request
protected  String title
          The title passed to the constructor
protected  PDFViewer viewer
          The viewer passed to the constructor
 
Constructor Summary
protected Importer.ImporterTask(PDFViewer viewer, InputStream in, String title, File file)
          Create a new ImporterTask which will read it's input from a File (if in is null) or from an InputStream.
 
Method Summary
 boolean isCancellable()
           
abstract  PDF loadPDF()
          Load and return a PDF.
 void run()
           
 void setFile(File file)
          Set the default file to save the file to if the PDF is later saved.
 void setPageNumber(int pagenumber)
          Set the initial pagenumber to display.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

viewer

protected final PDFViewer viewer
The viewer passed to the constructor


file

protected final File file
The file passed to the constructor


in

protected final InputStream in
The InputStream passed to the constructor


title

protected String title
The title passed to the constructor


pagenumber

protected int pagenumber
The initial pagenumber to request

Constructor Detail

Importer.ImporterTask

protected Importer.ImporterTask(PDFViewer viewer,
                                InputStream in,
                                String title,
                                File file)
Create a new ImporterTask which will read it's input from a File (if in is null) or from an InputStream.

Parameters:
viewer - the Viewer this task is going to add the PDF to
in - the InputStream to read the PDF from, or null to read the PDF from the file parameter
title - the title of the PDF - may be null
file - If in is null, the File to read the PDF from (may not be null). If in is not null, the file that is used as the default when this PDF is save, in which case it may be null.
Method Detail

isCancellable

public boolean isCancellable()

run

public void run()
         throws IOException
Throws:
IOException

setPageNumber

public void setPageNumber(int pagenumber)
Set the initial pagenumber to display. This may be overridden by a PDF openaction or if it is out of range

Since:
2.11.10

setFile

public void setFile(File file)
Set the default file to save the file to if the PDF is later saved. For PDFs loaded from a File, this defaults to the same file.

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

loadPDF

public abstract PDF loadPDF()
                     throws IOException
Load and return a PDF. Subclasses must implement this method, loading the PDF from the InputStream in if it's specified of the File file if it's not

Returns:
the PDF
Throws:
IOException


Copyright © 2001-2013 Big Faceless Organization