Package adams.flow.transformer.pdfproclet

Class 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 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.

    • Constructor Detail

      • Headline

        public Headline()

    • Method Detail

      • setPageBreakBefore

        public void setPageBreakBefore​(boolean value)
        Whether to add a page break before the file is inserted.
        Specified by:
        setPageBreakBefore in interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        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 interface PdfProcletWithPageBreaks
        Parameters:
        value - the number of files

      • numFilesPerPageTipText

        public String numFilesPerPageTipText()
        Returns the tip text for this property.
        Specified by:
        numFilesPerPageTipText in interface PdfProcletWithPageBreaks
        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.

      • 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 interface PdfProclet
        Overrides:
        canProcess in class AbstractPdfProclet
        Parameters:
        generator - the context
        file - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        file - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        file - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        file - 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 interface PdfProclet
        Specified by:
        canProcess in class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - 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 class AbstractPdfProclet
        Parameters:
        generator - the context
        obj - the object to add
        Returns:
        true if successfully added
        Throws:
        Exception - if something goes wrong