Package adams.flow.transformer.pdfproclet

Interface PdfProcletWithFilenameOutput

All Superinterfaces:

Destroyable, OptionHandler, PdfProclet

All Known Implementing Classes:

AbstractPdfProcletWithFilenameOutput, AbstractPdfProcletWithPageBreaks, AbstractSpreadSheetPdfProclet, ConfusionMatrix, Image, PlainText, SpreadSheet

public interface PdfProcletWithFilenameOutput
extends PdfProclet

Interface for PDF proclets that allow absolute positioning. From bottom-left corner.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	addFilenameTipText()	Returns the tip text for this property.
String	colorFilenameTipText()	Returns the tip text for this property.
String	fontFilenameTipText()	Returns the tip text for this property.
boolean	getAddFilename()	Returns whether to output the filename as well.
Color	getColorFilename()	Returns the color to use for adding the filename header.
PdfFont	getFontFilename()	Returns the font to use for adding the filename header.
void	setAddFilename(boolean value)	Sets whether to output the filename as well.
void	setColorFilename(Color value)	Sets the color to use for adding the filename header.
void	setFontFilename(PdfFont value)	Sets the font to use for adding the filename header.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.transformer.pdfproclet.PdfProclet

canProcess, canProcess, getExtensions, getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename

Method Detail

setAddFilename

void setAddFilename(boolean value)

Sets whether to output the filename as well.

Parameters:

value - if true then the filename gets added as well

getAddFilename

boolean getAddFilename()

Returns whether to output the filename as well.

Returns:

true if the filename gets added as well

addFilenameTipText

String addFilenameTipText()

Returns the tip text for this property.

Returns:

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

setFontFilename

void setFontFilename(PdfFont value)

Sets the font to use for adding the filename header.

Parameters:

value - the font

getFontFilename

PdfFont getFontFilename()

Returns the font to use for adding the filename header.

Returns:

the font

fontFilenameTipText

String fontFilenameTipText()

Returns the tip text for this property.

Returns:

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

setColorFilename

void setColorFilename(Color value)

Sets the color to use for adding the filename header.

Parameters:

value - the color

getColorFilename

Color getColorFilename()

Returns the color to use for adding the filename header.

Returns:

the color

colorFilenameTipText

String colorFilenameTipText()

Returns the tip text for this property.

Returns:

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