Package adams.gui.visualization.multiobjectexport

Class PDFExport

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.multiobjectexport.AbstractMultiObjectExport

adams.gui.visualization.multiobjectexport.AbstractMultiObjectExportWithPreferredExtensions

adams.gui.visualization.multiobjectexport.PDFExport

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class PDFExport
extends AbstractMultiObjectExportWithPreferredExtensions
implements FileWriter

Generates a PDF from the exported objects (first get turned into files).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_OutputFile	the output file.
protected PageOrientation	m_PageOrientation	the page orientation.
protected PageSize	m_PageSize	the page size.
protected PdfProclet[]	m_Proclets	the PDF processors.

Fields inherited from class adams.gui.visualization.multiobjectexport.AbstractMultiObjectExportWithPreferredExtensions

m_PreferredExtensions

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
PDFExport()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doExport(String[] names, Object[] objects)	Performs the actual export of the objects using the given names.
protected PdfProclet[]	getDefaultProclets()	Returns the default proclets to use.
PlaceholderFile	getOutputFile()	Returns the output file.
PageOrientation	getPageOrientation()	Returns the page orientation.
PageSize	getPageSize()	Returns the page size.
PdfProclet[]	getProclets()	Returns the processors in use.
String	globalInfo()	Returns a string describing the object.
String	outputFileTipText()	Returns the tip text for this property.
String	pageOrientationTipText()	Returns the tip text for this property.
String	pageSizeTipText()	Returns the tip text for this property.
String	procletsTipText()	Returns the tip text for this property.
void	setOutputFile(PlaceholderFile value)	Sets the output file.
void	setPageOrientation(PageOrientation value)	Sets the page orientation.
void	setPageSize(PageSize value)	Sets the page size.
void	setProclets(PdfProclet[] value)	Sets the processors for processing the files.

Methods inherited from class adams.gui.visualization.multiobjectexport.AbstractMultiObjectExportWithPreferredExtensions

determineExporters, determineExtension, getDefaultPreferredExtensions, getPreferredExtensions, preferredExtensionsTipText, setPreferredExtensions

Methods inherited from class adams.gui.visualization.multiobjectexport.AbstractMultiObjectExport

check, disambiguateNames, export, pruneExporters

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_OutputFile

protected PlaceholderFile m_OutputFile

the output file.

m_PageSize

protected PageSize m_PageSize

the page size.

m_PageOrientation

protected PageOrientation m_PageOrientation

the page orientation.

m_Proclets

protected PdfProclet[] m_Proclets

the PDF processors.

Constructor Detail

PDFExport

public PDFExport()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractMultiObjectExportWithPreferredExtensions

setOutputFile

public void setOutputFile(PlaceholderFile value)

Sets the output file.

Specified by:

setOutputFile in interface FileWriter

Parameters:

value - the file

getOutputFile

public PlaceholderFile getOutputFile()

Returns the output file.

Specified by:

getOutputFile in interface FileWriter

Returns:

the file

outputFileTipText

public String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface FileWriter

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPageSize

public void setPageSize(PageSize value)

Sets the page size.

Parameters:

value - the size

getPageSize

public PageSize getPageSize()

Returns the page size.

Returns:

the size

pageSizeTipText

public String pageSizeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setPageOrientation

public void setPageOrientation(PageOrientation value)

Sets the page orientation.

Parameters:

value - the orientation

getPageOrientation

public PageOrientation getPageOrientation()

Returns the page orientation.

Returns:

the orientation

pageOrientationTipText

public String pageOrientationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getDefaultProclets

protected PdfProclet[] getDefaultProclets()

Returns the default proclets to use.

Returns:

the default

setProclets

public void setProclets(PdfProclet[] value)

Sets the processors for processing the files.

Parameters:

value - the processors to use

getProclets

public PdfProclet[] getProclets()

Returns the processors in use.

Returns:

the processors in use

procletsTipText

public String procletsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doExport

protected String doExport(String[] names,
                          Object[] objects)

Performs the actual export of the objects using the given names.

Specified by:

doExport in class AbstractMultiObjectExport

Parameters:

names - the names for the objects

objects - the objects

Returns:

null if successful, otherwise error message