Package adams.flow.transformer.pdfproclet

Interface PdfProcletWithPageBreaks

All Superinterfaces:

Destroyable, OptionHandler, PdfProclet

All Known Implementing Classes:

AbstractPdfProcletWithPageBreaks, AbstractSpreadSheetPdfProclet, ConfusionMatrix, FixedText, Headline, Image, MetaHeadline, PlainText, SpreadSheet

public interface PdfProcletWithPageBreaks
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
int	getNumFilesPerPage()	Returns the number of files to put on a single page.
boolean	getPageBreakAfter()	Returns whether a page break is added after the file is inserted.
boolean	getPageBreakBefore()	Returns whether a page break is added before the file is inserted.
String	numFilesPerPageTipText()	Returns the tip text for this property.
String	pageBreakAfterTipText()	Returns the tip text for this property.
String	pageBreakBeforeTipText()	Returns the tip text for this property.
void	setNumFilesPerPage(int value)	Sets the number of files per page.
void	setPageBreakAfter(boolean value)	Whether to add a page break after the file is inserted.
void	setPageBreakBefore(boolean value)	Whether to add a page break before the file is inserted.

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

setPageBreakBefore

void setPageBreakBefore(boolean value)

Whether to add a page break before the file is inserted.

Parameters:

value - if true then a page-break is added before the file is inserted

getPageBreakBefore

boolean getPageBreakBefore()

Returns whether a page break is added before the file is inserted.

Returns:

true if a page break is added before the file is inserted

pageBreakBeforeTipText

String pageBreakBeforeTipText()

Returns the tip text for this property.

Returns:

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

setPageBreakAfter

void setPageBreakAfter(boolean value)

Whether to add a page break after the file is inserted.

Parameters:

value - if true then a page-break is added after the file is inserted

getPageBreakAfter

boolean getPageBreakAfter()

Returns whether a page break is added after the file is inserted.

Returns:

true if a page break is added after the file is inserted

pageBreakAfterTipText

String pageBreakAfterTipText()

Returns the tip text for this property.

Returns:

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

setNumFilesPerPage

void setNumFilesPerPage(int value)

Sets the number of files per page.

Parameters:

value - the number of files

getNumFilesPerPage

int getNumFilesPerPage()

Returns the number of files to put on a single page.

Returns:

the number of files

numFilesPerPageTipText

String numFilesPerPageTipText()

Returns the tip text for this property.

Returns:

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