Class Headline
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.pdfproclet.AbstractPdfProclet
-
- adams.flow.transformer.pdfproclet.Headline
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,PdfProclet
,PdfProcletWithPageBreaks
,PdfProcletWithVariableFileExtension
,Serializable
public class Headline extends AbstractPdfProclet implements PdfProcletWithPageBreaks, PdfProcletWithVariableFileExtension
Adds a simple headline, but no file content.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING min-user-mode: Expert
-regexp-filename <adams.core.base.BaseRegExp> (property: regExpFilename) The regular expression that the filename must match. default: .* more: https://docs.oracle.com/javase/tutorial/essential/regex/ https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html
-page-break-before <boolean> (property: pageBreakBefore) If true, then a page-break is added before the content of the file is inserted. default: false
-page-break-after <boolean> (property: pageBreakAfter) If true, then a page-break is added after the content of the file is inserted. default: false
-num-files <int> (property: numFilesPerPage) The number of files to put on a page before adding an automatic page break; use -1 for unlimited. default: -1 minimum: -1
-headline <adams.core.base.BaseText> (property: headline) The headline to add, can be multi-line; variables get expanded automatically. default: Fill in headline
-font-headline <adams.core.io.PdfFont> (property: fontHeadline) The font to use for the headline. default: Helvetica-Bold-14
-color-headline <java.awt.Color> (property: colorHeadline) The color to use for the headline. default: #000000
-extension <adams.core.base.BaseString> [-extension ...] (property: extensions) The file extension(s) that the processor will be used for. default: *
-first-page-only <boolean> (property: firstPageOnly) If set to true, then the headline is only added to the first page. default: false
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected Color
m_ColorHeadline
the color for the headline.protected BaseString[]
m_Extensions
the file extensions.protected boolean
m_FirstPageOnly
whether to add it only on the first page.protected PdfFont
m_FontHeadline
the font for the headline.protected BaseText
m_Headline
the headline to add.protected int
m_NumFilesPerPage
the number of files per page.protected boolean
m_PageBreakAfter
whether to add a page-break after adding the file.protected boolean
m_PageBreakBefore
whether to add a page-break before adding the file.-
Fields inherited from class adams.flow.transformer.pdfproclet.AbstractPdfProclet
m_RegExpFilename, MATCH_ALL_EXTENSION
-
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 Headline()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canProcess(PDFGenerator generator, File file)
Whether the processor can handle this particular file.boolean
canProcess(PDFGenerator generator, Object obj)
Whether the processor can handle this particular object.String
colorHeadlineTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected boolean
doProcess(PDFGenerator generator, File file)
The actual processing of the document.protected boolean
doProcess(PDFGenerator generator, Object obj)
The actual processing of the document.String
extensionsTipText()
Returns the tip text for this property.String
firstPageOnlyTipText()
Returns the tip text for this property.String
fontHeadlineTipText()
Returns the tip text for this property.Color
getColorHeadline()
Returns the color to use for the headline.BaseString[]
getExtensions()
Returns the extensions that the processor can process.boolean
getFirstPageOnly()
Returns the whether to add the headline only on the first page.PdfFont
getFontHeadline()
Returns the font to use for the headline.BaseText
getHeadline()
Returns the headline to add.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
globalInfo()
Returns a short description of the writer.String
headlineTipText()
Returns the tip text for this property.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.protected boolean
postProcess(PDFGenerator generator, File file)
For post-processing the document.protected boolean
postProcess(PDFGenerator generator, Object obj)
For post-processing the document.protected boolean
preProcess(PDFGenerator generator, File file)
For pre-processing the document.protected boolean
preProcess(PDFGenerator generator, Object obj)
For pre-processing the document.void
setColorHeadline(Color value)
Sets the color to use for the headline.void
setExtensions(BaseString[] value)
Sets the extensions that the processor can process.void
setFirstPageOnly(boolean value)
Sets the whether to add the headline only on the first page.void
setFontHeadline(PdfFont value)
Sets the font to use for the headline.void
setHeadline(BaseText value)
Sets the headline to add.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 class adams.flow.transformer.pdfproclet.AbstractPdfProclet
addColumnTextAt, addElement, getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename
-
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.Destroyable
destroy
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine
-
Methods inherited from interface adams.flow.transformer.pdfproclet.PdfProclet
getRegExpFilename, process, process, regExpFilenameTipText, setRegExpFilename
-
-
-
-
Field Detail
-
m_PageBreakBefore
protected boolean m_PageBreakBefore
whether to add a page-break before adding the file.
-
m_PageBreakAfter
protected boolean m_PageBreakAfter
whether to add a page-break after adding the file.
-
m_NumFilesPerPage
protected int m_NumFilesPerPage
the number of files per page.
-
m_Headline
protected BaseText m_Headline
the headline to add.
-
m_FontHeadline
protected PdfFont m_FontHeadline
the font for the headline.
-
m_ColorHeadline
protected Color m_ColorHeadline
the color for the headline.
-
m_Extensions
protected BaseString[] m_Extensions
the file extensions.
-
m_FirstPageOnly
protected boolean m_FirstPageOnly
whether to add it only on the first page.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a short description of the writer.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description of the writer
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractPdfProclet
-
setPageBreakBefore
public void setPageBreakBefore(boolean value)
Whether to add a page break before the file is inserted.- Specified by:
setPageBreakBefore
in interfacePdfProcletWithPageBreaks
- Parameters:
value
- if true then a page-break is added before the file is inserted
-
getPageBreakBefore
public boolean getPageBreakBefore()
Returns whether a page break is added before the file is inserted.- Specified by:
getPageBreakBefore
in interfacePdfProcletWithPageBreaks
- Returns:
- true if a page break is added before the file is inserted
-
pageBreakBeforeTipText
public String pageBreakBeforeTipText()
Returns the tip text for this property.- Specified by:
pageBreakBeforeTipText
in interfacePdfProcletWithPageBreaks
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setPageBreakAfter
public void setPageBreakAfter(boolean value)
Whether to add a page break after the file is inserted.- Specified by:
setPageBreakAfter
in interfacePdfProcletWithPageBreaks
- Parameters:
value
- if true then a page-break is added after the file is inserted
-
getPageBreakAfter
public boolean getPageBreakAfter()
Returns whether a page break is added after the file is inserted.- Specified by:
getPageBreakAfter
in interfacePdfProcletWithPageBreaks
- Returns:
- true if a page break is added after the file is inserted
-
pageBreakAfterTipText
public String pageBreakAfterTipText()
Returns the tip text for this property.- Specified by:
pageBreakAfterTipText
in interfacePdfProcletWithPageBreaks
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setNumFilesPerPage
public void setNumFilesPerPage(int value)
Sets the number of files per page.- Specified by:
setNumFilesPerPage
in interfacePdfProcletWithPageBreaks
- Parameters:
value
- the number of files
-
getNumFilesPerPage
public int getNumFilesPerPage()
Returns the number of files to put on a single page.- Specified by:
getNumFilesPerPage
in interfacePdfProcletWithPageBreaks
- Returns:
- the number of files
-
numFilesPerPageTipText
public String numFilesPerPageTipText()
Returns the tip text for this property.- Specified by:
numFilesPerPageTipText
in interfacePdfProcletWithPageBreaks
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setHeadline
public void setHeadline(BaseText value)
Sets the headline to add.- Parameters:
value
- the headline
-
getHeadline
public BaseText getHeadline()
Returns the headline to add.- Returns:
- the headline
-
headlineTipText
public String headlineTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setFontHeadline
public void setFontHeadline(PdfFont value)
Sets the font to use for the headline.- Parameters:
value
- the font
-
getFontHeadline
public PdfFont getFontHeadline()
Returns the font to use for the headline.- Returns:
- the font
-
fontHeadlineTipText
public String fontHeadlineTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setColorHeadline
public void setColorHeadline(Color value)
Sets the color to use for the headline.- Parameters:
value
- the color
-
getColorHeadline
public Color getColorHeadline()
Returns the color to use for the headline.- Returns:
- the color
-
colorHeadlineTipText
public String colorHeadlineTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getExtensions
public BaseString[] getExtensions()
Returns the extensions that the processor can process.- Specified by:
getExtensions
in interfacePdfProclet
- Specified by:
getExtensions
in interfacePdfProcletWithVariableFileExtension
- Specified by:
getExtensions
in classAbstractPdfProclet
- Returns:
- the extensions (no dot)
-
setExtensions
public void setExtensions(BaseString[] value)
Sets the extensions that the processor can process.- Specified by:
setExtensions
in interfacePdfProcletWithVariableFileExtension
- Parameters:
value
- the extensions (no dot)
-
extensionsTipText
public String extensionsTipText()
Returns the tip text for this property.- Specified by:
extensionsTipText
in interfacePdfProcletWithVariableFileExtension
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setFirstPageOnly
public void setFirstPageOnly(boolean value)
Sets the whether to add the headline only on the first page.- Parameters:
value
- if true then the headline is only added on the first page
-
getFirstPageOnly
public boolean getFirstPageOnly()
Returns the whether to add the headline only on the first page.- Returns:
- true if the headline is only on the first page
-
firstPageOnlyTipText
public String firstPageOnlyTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
canProcess
public boolean canProcess(PDFGenerator generator, File file)
Whether the processor can handle this particular file.- Specified by:
canProcess
in interfacePdfProclet
- Overrides:
canProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextfile
- the file to check- Returns:
- true if the file can be handled
-
preProcess
protected boolean preProcess(PDFGenerator generator, File file) throws Exception
For pre-processing the document.- Overrides:
preProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextfile
- the file to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
doProcess
protected boolean doProcess(PDFGenerator generator, File file) throws Exception
The actual processing of the document.- Specified by:
doProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextfile
- the file to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
postProcess
protected boolean postProcess(PDFGenerator generator, File file) throws Exception
For post-processing the document.- Overrides:
postProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextfile
- the file to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
canProcess
public boolean canProcess(PDFGenerator generator, Object obj)
Whether the processor can handle this particular object.- Specified by:
canProcess
in interfacePdfProclet
- Specified by:
canProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- the object to check- Returns:
- true if the object can be handled
-
preProcess
protected boolean preProcess(PDFGenerator generator, Object obj) throws Exception
For pre-processing the document.- Overrides:
preProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- the object to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
doProcess
protected boolean doProcess(PDFGenerator generator, Object obj) throws Exception
The actual processing of the document.- Specified by:
doProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- the object to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
postProcess
protected boolean postProcess(PDFGenerator generator, Object obj) throws Exception
For post-processing the document.- Overrides:
postProcess
in classAbstractPdfProclet
- Parameters:
generator
- the contextobj
- the object to add- Returns:
- true if successfully added
- Throws:
Exception
- if something goes wrong
-
-