|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.faceless.pdf2.viewer2.ViewerFeature
org.faceless.pdf2.viewer2.Exporter
public abstract class Exporter
A type of ViewerFeature
which allows PDF's to be saved in a variety of formats.
It's chiefly used with the Save
widget, although it can be
used in other contexts if necessary.
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.
Nested Class Summary | |
---|---|
class |
Exporter.ExporterTask
This class is a LongRunningTask that can be run to save a PDF to
an OutputStream. |
Constructor Summary | |
---|---|
Exporter(String name)
Create a new Exporter |
Method Summary | |
---|---|
JComponent |
getComponent()
Return a JComponent which prompts the user for additional information after the initial save dialog. |
abstract Exporter.ExporterTask |
getExporter(DocumentPanel panel,
PDF pdf,
JComponent component,
OutputStream out)
Return a new Exporter.ExporterTask that would save a PDF |
abstract FileFilter |
getFileFilter()
Get a FileFilter that matches the Files output by this Exporter |
abstract String |
getFileSuffix()
Return the suffix of files normally output by this Exporter, such as "pdf", "tif", "jpg" etc. |
boolean |
isEnabled(DocumentPanel docpanel)
Return true if this Exporter should be available for this DocumentPanel. |
void |
postProcessPDF(PDF pdf)
Called by Exporter.ExporterTask.savePDF() just after the PDF is saved,
you can override this method for custom processing. |
void |
preProcessPDF(PDF pdf)
Called by Exporter.ExporterTask.savePDF() just before the PDF is saved,
you can override this method for custom processing. |
String |
validateComponent(JComponent comp)
Given the component returned by getComponent() , return null
if the values are valid or an error message if they're invalid. |
Methods inherited from class org.faceless.pdf2.viewer2.ViewerFeature |
---|
getAllEnabledFeatures, getAllFeatures, getCustomJavaScript, getFeatureProperty, getFeatureURLProperty, getName, initialize, isEnabledByDefault, setFeatureName, teardown, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Exporter(String name)
name
- the name of the featureMethod Detail |
---|
public abstract FileFilter getFileFilter()
public abstract String getFileSuffix()
public boolean isEnabled(DocumentPanel docpanel)
public abstract Exporter.ExporterTask getExporter(DocumentPanel panel, PDF pdf, JComponent component, OutputStream out)
Exporter.ExporterTask
that would save a PDF
panel
- the DocumentPanel this PDF is being saved from - may be nullpdf
- the PDF being saves (not null)component
- the JComponent returned by getComponent()
out
- the OutputStream to write the PDF topublic JComponent getComponent()
null
(the default), then no additional component will
be displayed on save.
public String validateComponent(JComponent comp)
getComponent()
, return null
if the values are valid or an error message if they're invalid.
comp
- the Component returned by getComponent()
public void preProcessPDF(PDF pdf)
Exporter.ExporterTask.savePDF()
just before the PDF is saved,
you can override this method for custom processing. By default
it's a no-op
public void postProcessPDF(PDF pdf)
Exporter.ExporterTask.savePDF()
just after the PDF is saved,
you can override this method for custom processing. By default
it's a no-op
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |